• No results found

2 Messages

2.2 Common Data Types

2.2.6 Result Sets

2.2.6.1 Site Collection Flags Result Set

The Site Collection Flags Result Set returns information about the site collection that has been deleted. The Site Collection Flags Result Set MUST return one row if the site collection specified by the @SiteId parameter existed in the content database and was deleted. If the site collection specified by the @SiteId parameter did not exist in the content database, the Site Collection Flags Result Set MUST NOT return any rows. The T-SQL syntax for the result set is as follows:

BitFlags int;

BitFlags: Contains the site collection flags of the site collection specified by the @SiteId parameter.

For more information regarding site collection flags, see [MS-WSSFO2] section 2.2.2.9.

2.2.6.2 Distribution List E-mail Address Result Set

The Distribution List E-mail Address Result Set returns information about the site collection that has been deleted. If the site collection specified by the @SiteId parameter existed in the content database and was deleted, then the Distribution List E-mail Address result set MUST return one row for each of the site collection's security groups that contains a distribution list e-mail

address If, however, the deleted site collection's security groups do not contain any distribution list e-mail addresses, then the Distribution List E-mail Address result set MUST NOT return any rows. If the site collection specified by the @SiteId parameter did not exist in the content database then the Distribution List E-mail Address result set MUST NOT return any rows. The T-SQL syntax for the result set is as follows:

DLAlias nvarchar(128);

DLAlias: Contains a distribution list e-mail address for the deleted site collection specified by the

@SiteId parameter.

2.2.6.3 Document Content Stream Transfer Result Set

The Document Content Stream Transfer Result Set returns information about the document streams in a site collection. Each row corresponds to a document stream along with associated metadata. The T-SQL syntax for the result set is as follows:

Size int, DocFlags int,

{Content} varbinary(max), {RbsResReference} varbinary(800), Id uniqueidentifier, InternalVersion int,

Level tinyint,

Size: The size, in bytes, of the document stream of the document.

DocFlags: The Document Flags for the document.

{Content}: The document's content stream. For an uncustomized document or if the document has external storage, this MUST be NULL. Otherwise, if the content is larger than the value specified in the @ChunkSize parameter, only the first @ChunkSize bytes MUST be returned, and the front-end Web server can request individual chunks of content in a subsequent request.

{RbsResReference}: If remote binary large object (BLOB) storage is enabled and the content of the document is contained in a remote data store, this MUST be the remote BLOB storage identifier for the document’s content. If remote BLOB storage is disabled or the content of the document is not contained in a remote data store, this MUST be NULL. Further information about remote BLOB storage can be found in [MS-WSSO] section 2.1.2.3.8.

Id: The document identifier of the document.

InternalVersion: The internal version number of the document.

Level: The publishing level of the specified document.

2.2.6.4 Document Version Content Stream Transfer Result Set

The Document Version Content Stream Transfer Result Set returns information about the document streams for document versions in a site collection. Each row corresponds to a document stream for a document version along with associated metadata. The T-SQL syntax for the result set is as follows:

Size int, DocFlags int,

{Content} varbinary(max), {RbsResReference} varbinary(800), Id uniqueidentifier, InternalVersion int,

UIVersion int,

Size: The size, in bytes, of the document stream of the document version.

DocFlags: The Document Flags for the document version.

{Content}: The content stream of the document version. For an uncustomized document or if the document has external storage, this MUST be NULL. Otherwise, if the content is larger than the value specified in the @ChunkSize parameter, only the first @ChunkSize bytes MUST be returned, and the front-end Web server can request individual chunks of content in a subsequent request.

{RbsResReference}: If remote BLOB storage is enabled and the content of the document is contained in a remote data store, this MUST be the remote BLOB storage identifier for the document’s content. If remote BLOB storage is disabled or the content of the document is not contained in a remote data store, this MUST be NULL. Further information about remote BLOB storage can be found in [MS-WSSO] section 2.1.2.3.8.

Id: The document identifier (2) of the document version.

InternalVersion: The internal version number of the document version.

UIVersion: The user interface (UI) version number of the specified document version.

2.2.6.5 Document Stream Storage Migration Result Set

The Document Stream Storage Migration Result Set returns information about the document streams in a site collection for remote data store management. Each row corresponds to a document stream along with associated metadata. The T-SQL syntax for the result set is as follows:

Size int, DocFlags int,

{Content} varbinary(max), {RbsResReference} varbinary(800), Id uniqueidentifier, InternalVersion int,

Level tinyint,

SiteId uniqueidentifier, DeleteTransactionId uniqueidentifier, ParentId uniqueidentifier

Size: The size, in bytes, of the document stream of the document.

DocFlags: The Document Flags for the document.

{Content}: The document's content stream. For an uncustomized document or if the document has external storage, this MUST be NULL. Otherwise, if the content is larger than the value specified in the @ChunkSize parameter, only the first @ChunkSize bytes MUST be returned, and the front-end Web server can request individual chunks of content in a subsequent request.

{RbsResReference}: If remote BLOB storage is enabled and the content of the document is contained in a remote data store, this MUST be the remote BLOB storage identifier for the document’s content. If remote BLOB storage is disabled or the content of the document is not contained in a remote data store, this MUST be NULL. Further information about remote BLOB storage can be found in [MS-WSSO] section 2.1.2.3.8.

Id: The document identifier (2) of the document.

InternalVersion: The internal version number of the document.

Level: The publishing level of the document.

SiteId: The site collection identifier of the site collection containing the document.

DeleteTransactionId: The delete transaction identifier of the document.

ParentId: The document identifier (2) of the parent container of the document.

2.2.6.6 Document Version Stream Storage Migration Result Set

The Document Version Stream Storage Migration Result Set returns information about the document streams for document versions in a site collection for remote data store management.

Each row corresponds to a document stream for a document version along with associated metadata. The T-SQL syntax for the result set is as follows:

Size int, DocFlags int,

{Content} varbinary(max), {RbsResReference} varbinary(800), Id uniqueidentifier, InternalVersion int,

UIVersion int,

SiteId uniqueidentifier

Size: The size, in bytes, of the document stream of the document version.

DocFlags: The Document Flags for the document version.

{Content}: The content stream of the document version. For an uncustomized document or if the document has external storage, this MUST be NULL. Otherwise, if the content is larger than the value specified in the @ChunkSize parameter, only the first @ChunkSize bytes MUST be returned, and the front-end Web server can request individual chunks of content in a subsequent request.

{RbsResReference}: If remote BLOB storage is enabled and the content of the document is contained in a remote data store, this MUST be the remote BLOB storage identifier for the document’s content. If remote BLOB storage is disabled or the content of the document is not contained in a remote data store, this MUST be NULL. Further information about remote BLOB storage can be found in [MS-WSSO] section 2.1.2.3.8.

Id: The document identifier (2) of the document version.

InternalVersion: The internal version number of the document version.

UIVersion: The UI version number of the document version.

SiteId: The site collection identifier of the site collection containing the document.

2.2.6.7 File Fragment Result Set

The File Fragment Result Set contains information about the file fragments being fetched. If

@GetAfter is 1, @TopRows number of file fragments with File Fragment Identifier greater than

@Id MUST be fetched. Otherwise, if @GetOnly is 1, only one file fragment with File Fragment Identifier equal to @Id MUST be fetched. If both @GetAfter and @GetOnly are zero, @Id MUST be ignored and @TopRows number of file fragments MUST be fetched, starting from the smallest available File Fragment Identifier for the document specified by @DocId.

There MUST be one row for each file fragment being fetched. The result set MUST be sorted by File Fragment Identifier in ascending order.

The T-SQL syntax for the result set is as follows:

Id bigint, Partition tinyint, Tag varbinary(40), BlobSize int

{BlobData} varbinary(max)

Id: The File Fragment Identifier of the file fragment.

Partition: The identifier of a file fragment partition for the file fragment partition in which the file fragment belongs.

Tag: The file fragment tag for the file fragment.

{BlobData}: The data for this file fragment.

BlobSize: The size in bytes of the entire data of this file fragment.