2.2.4.16 Document Version Metadata Result Set

The Document Version Metadata Result Set contains the metadata about the requested version of the document. The Document Version Metadata Result Set is defined using T-SQL syntax, as follows.

 Id                            uniqueidentifier,
 {FullUrl}                     nvarchar(256),
 Type                          tinyint,
 MetaInfoTimeLastModified      datetime,
 MetaInfo                      image,
 Size                          int,
 TimeCreated                   datetime,
 TimeCreated                   datetime,
 Version                       int,
 DocFlags                      tinyint,
 {ListType}                    int,
 {tp_Name}                     int,
 {ListTitle}                   nvarchar(255),
 {CacheParseId}                int,
 {GhostDirName}                int,
 {GhostLeafName}               int,
 {tp_Login}                    int,
 {CheckoutDate}                datetime,
 {CheckoutExpires}             datetime,
 VirusStatus                   int,
 VirusInfo                     nvarchar(255),
 SetupPath                     nvarchar(255),
 NextToLastTimeModified        datetime,
 Version                       int;

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

{FullUrl}: The full store-relative form URL for the document being requested.

Type: The Document Store Type (section 2.2.2.3) of this document.

MetaInfoTimeLastModified: A time stamp in UTC format specifying the last time the MetaInfo value of this document was changed, which is useful for providing minimal metadata returns to clients. This value can be NULL.

MetaInfo: A metadict for this document version. The metadict format is specified in [MS-FPSE]. This value can be NULL.

Size: The number of bytes in the document stream of the document version requested. This value can be NULL.

TimeCreated: A time stamp in UTC format specifying when this document was created.

TimeCreated: A time stamp in UTC format specifying when the document was last saved. This corresponds to the TimeCreated or TimeLastModified of the document version requested.

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

DocFlags: A Doc Flags (section 2.2.2.2) value describing this document. This value can be NULL.

{ListType}: A packed combination of the List Base Type (section 2.2.1.9) and List Server Template (section 2.2.1.12) values of the associated list (1) for the document. This value MUST be NULL.

{tp_Name}: The identifier of the list (1) that contains the document. This value MUST be NULL.

{ListTitle}: Specifies the title of the list, if this document is the root folder of a list (1). This value MUST be NULL.

{CacheParseId}: Used for concurrency detection if two different requests attempt to perform dependency update or resetting the dirty bits on a document at the same time. If @CacheParse is set to 1, this field MUST reflect the value stored for the document. Otherwise, it MUST return NULL.

{GhostDirName}: A placeholder for a directory name. This value MUST be NULL.

{GhostLeafName}: A placeholder for a leaf name. This value MUST be NULL.

{tp_Login}: If this document exists and is currently checked out, this is the login name of the user to whom it is checked out. In all other cases, this MUST be NULL.

{CheckoutDate}: A time stamp in UTC format specifying when this document was checked out. This value can be NULL.

{CheckoutExpires}: A time stamp in UTC format specifying when the short-term lock for this document will expire. If this date is in the past, the document SHOULD be treated as unlocked. This value can be NULL if no short-term lock has been placed on the document. This value MUST be NULL if a user has the document checked out.

VirusStatus: An enumerated type specifying the current virus state of this document version. This value can be NULL if it has not been processed by a virus scanner. Valid values are listed in the Virus Status (section 2.2.1.26) section.

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 it has not been processed by a virus scanner.

SetupPath: For a document that is now or once was ghosted, this contains the setup path fragment relative to the base setup. This value can be NULL.

NextToLastTimeModified: The value of TimeLastModified of Docs Table (section 2.2.5.1) from the previous time when the document was last saved. If the NextToLastTimeModified value matches the TimeLastModified value when the rename occurred and the client has a document that it has successfully fixed up, the client can safely submit the document to the server despite what appears to be an intervening edit to the document. This value can be NULL.

Version: The UI version number for the document. This value can be produced as the integer counter described earlier (the first Version field). This value MUST match @Version.