3.1.5.47.5 Document Metadata Result Set

The Document Metadata Result Set contains the metadata for the specified document. If the document is not a folder or if the @DirFullUrl parameter contains an empty string, the Document Metadata Result Set MUST NOT be returned. Otherwise, the Document Metadata Result Set MUST contain one row with the metadata information for the document.

       Id                             uniqueidentifier,
       {FullUrl}                      nvarchar(260),
       Type                           tinyint,
       MetaInfoTimeLastModified       datetime,
       MetaInfo                       varbinary(max),
       Size                           int,
       TimeCreated                    datetime,
       TimeLastModified               datetime,
       ETagVersion                    int,
       DocFlags                       int,
       {ListType}                     int,
       tp_Name                        nvarchar(38),
       {ListTitle}                    nvarchar(255),
       CacheParseId                   uniqueidentifier,
       {GhostDirName}                 nvarchar(256),
       {GhostLeafName}                nvarchar(128),
       {tp_Login}                     nvarchar(255),
       {CheckoutDate}                 datetime,
       {CheckoutExpires}              datetime,
       VirusStatus                    int,
       VirusInfo                      nvarchar(255),
       SetupPathVersion               tinyint,
       SetupPath                      nvarchar(255),
       SetupPathUser                  nvarchar(255),
       NextToLastTimeModified         datetime,
       UIVersion                      int,
       CheckinComment                 nvarchar(1023),
       WelcomePageUrl                 nvarchar(260),
       WelcomePageParameters          nvarchar(max),
       tp_Flags                       bigint,
       Acl                            varbinary(max),
       AnonymousPermMask              bigint,
       DraftOwnerId                   int,
       Level                          tinyint,
       ParentVersion                  int,
       TransformerId                  uniqueidentifier,
       ParentLeafName                 nvarchar(128),
       ProgId                         nvarchar(255),
       DoclibRowId                    int,
       tp_DefaultWorkflowId           uniqueidentifier,
       ListId                         uniqueidentifier,
       ItemChildCount                 int,
       FolderChildCount               int,
       MetaInfoVersion                int,
       {CurVerMetaInfo}               varbinary(max),
       ContentVersion                 int,
       IsDirty                        bit,
       {NextBSN}                      bigint,
       {StreamSchema}                 tinyint,  
       {InternalVersion}              int

Id: The Document Identifier (section 2.2.1.1.2) of the document.

{FullUrl}: The URL in store-relative form for the document.

Type: The Document Store Type (section 2.2.2.4) of the document.

MetaInfoTimeLastModified: A datetime with a timestamp in UTC format specifying the last time the Metainfo column value of the document was changed. This value MUST be NULL if the Metainfo column value of the document has never been changed.

MetaInfo: A metadict for the document. The metadict format is specified in [MS-FPSE] section 2.2.2.2.11. This value MUST be NULL if the document does not have any metadict associated with it.

Size: The number of bytes in the document stream of the document. This value MUST be NULL if the document does not have a document stream.

TimeCreated: A datetime with a timestamp in UTC format specifying when the document was created.

TimeLastModified: A datetime with a timestamp in UTC format specifying when the document was last modified.

ETagVersion: A counter used for internal conflict detection that is incremented any time a change is made to the document.

DocFlags: A Doc Flags value (section 2.2.2.3) describing the document. This value MUST be NULL if the document does not have any Doc Flags associated with it.

{ListType}: A packed combination of the List Base Type (section 2.2.1.2.11) and List Server Template (section 2.2.1.2.12) values of the list containing this document, consisting of the List Server Template value multiplied by 256 and added to the value of the List Base Type.

tp_Name: The List Identifier (section 2.2.1.1.5) of the list (1) containing this document.

{ListTitle}: If the document URL is the root folder of a list (1), this contains the display name of the list (1). Otherwise, this value MUST be NULL.

CacheParseId: This value MUST be NULL.

{GhostDirName}: This value MUST be NULL.

{GhostLeafName}: This value MUST be NULL.

{tp_Login}: This value MUST be NULL.

{CheckoutDate}: This value MUST be NULL.

{CheckoutExpires}: This value MUST be NULL.

VirusStatus: A Virus Status (section 2.2.1.2.17) value specifying the current virus state of the document. This value can be NULL if the document has not been processed by a virus scanner.

VirusInfo: A string containing a provider-specific message returned by the virus scanner when it last processed the document. This value can be NULL if the document has not been processed by a virus scanner.

SetupPathVersion: If this is an uncustomized document, this specifies the setup path location that the SetupPath fragment is relative to. This value MUST NOT be NULL. The following are valid values.

Value

Description

2

The SetupPath is relative to the install location of Windows SharePoint Services 2.0 on the front-end Web server (for example, Program Files\Common Files\Microsoft Shared\Web Server Extensions\60).

3

The SetupPath is relative to the install location of Windows SharePoint Services 3.0 on the front-end Web server (for example, Program Files\Common Files\Microsoft Shared\Web Server Extensions\12).

4

The SetupPath is relative to the install location of SharePoint Foundation 2010 on the front-end Web server (for example, Program Files\Common Files\Microsoft Shared\Web Server Extensions\14).

15

The SetupPath is relative to the install location of Microsoft SharePoint Foundation 2013 on the front-end Web server (for example, Program Files\Common Files\Microsoft Shared\Web Server Extensions\15).

16

The SetupPath is relative to the install location of Microsoft SharePoint Server 2016 on the front-end Web server (for example, Program Files\Common Files\Microsoft Shared\Web Server Extensions\16).

SetupPath: If the document is now or once was uncustomized, this contains the setup path fragment relative to the base setup path described above by the SetupPathVersion value where the document stream of the document can be found. This value can be NULL.

SetupPathUser: If the document is now or once was uncustomized, this contains the login name of the user who created the uncustomized document. This value can be NULL.

NextToLastTimeModified: The value of TimeLastModified from the previous time when the document was last saved. If the NextToLastTimeModified value matches the TimeLastModified value when the change occurred and the client has a version of the document that it has successfully modified, the client can safely submit the document to the server despite what appears to be an intervening edit to the document. This value MUST be NULL if the document has never been saved.

UIVersion: The UI version number for the document.

CheckinComment: An optional user-supplied description provided when the document is checked in or published. This value can be NULL.

WelcomePageUrl: If the document is a folder, this specifies an optional page to redirect to when the folder is requested with an HTTP GET operation. The URL is relative to the URL of the folder itself, and MUST be contained within that folder. Attempts to break out of the folder, such as "../../somepage.aspx", are not valid. This value can be NULL.

WelcomePageParameters: Contains optional URL parameters to specify as part of the WelcomePageUrl value. These parameters start at either the query string signifier '?' or the bookmark signifier '#'. This value can be NULL.

tp_Flags: The List Flags value (section 2.2.2.5) for the list (1) that contains the document.

Acl: The binary serialization of the WSS ACL Format (section 2.2.3.6) for the document. The WSS ACL is either explicitly defined for the document or inherited from the parent object of the document. This value can be NULL.

AnonymousPermMask: A WSS Rights Mask (section 2.2.2.15) that indicates the permissions granted anonymous users or those users that have no specific permissions to the document. This value can be NULL if anonymous access to the document is not allowed.

DraftOwnerId: The User Identifier (section 2.2.1.1.13) of the user that published the document as a draft. This value MUST be NULL if the document is not a draft version.

Level: A Publishing Level Type value (section 2.2.2.6) specifying the publishing status of the document.

ParentVersion: If the document is a transformed version of another document, this is the UI version value from the original document. This value MUST be NULL if the document is not the product of a document transformation.

TransformerId: If the document is a transformed version of another document, this is the GUID of the agent that performed the transformation. This value MUST be NULL if the document is not the product of a document transformation.

ParentLeafName: If the document is a transformed version of another document, this is the leaf name of the original document. The original document MUST be in the same folder as the transformed document. If either is moved, the relationship is broken. This value MUST be NULL if the document is not the product of a document transformation.

ProgId: Specifies a preferred application to open the document. The ProgId value is used to distinguish between different applications that save files with a given file extension (for example, different editors for .HTML or .XML files). This value MUST be NULL if a ProgId was not specified when the document was saved.

DoclibRowId: The identifier for a row in a document library for the document. If the document is not contained in a list (1), this value MUST be NULL.

tp_DefaultWorkflowId: The Workflow Identifier (section 2.2.1.1.16) corresponding to the workflow to be invoked if the document is in a moderated list (1) and the document is submitted for approval as part of a check in.

ListId: The list identifier of the list (1) that contains the document. If the document is not contained in a list (1), this value MUST be NULL.

ItemChildCount: The value MUST be the number of list items for the list (1) that contains the document.

FolderChildCount: The value MUST be the number of folders that exist in the list (1) that contains the document.

MetaInfoVersion: A counter used for internal conflict detection that is incremented any time a change is made to the MetaInfo for this document.

{CurVerMetaInfo}: The value MUST be NULL.

ContentVersion: The version number of the document stream being returned.

IsDirty: A bit that specifies this document MUST have implementation-specific processing performed before its stream can be returned. If this document does not require processing, this value MUST be zero.

{NextBSN}: The current BLOB sequence number of the document being returned.

{StreamSchema}: The current stream schema of the document being returned.

{InternalVersion}: The internal version number of the document being returned.