proc_GetListDataLinks

The proc_GetListDataLinks stored procedure is called to get the list of dirty field (1) links for a range of list items in a site (2), sorted alphabetically from (@FirstDirName, @FirstLeafName,

@FirstLevel) to (@LastDirName, @LastLeafName, @LastLevel), inclusive of the endpoints. The purpose of this stored procedure is to finish cleaning up links after list (1) location or other metadata has been updated. The T-SQL syntax for the stored procedure is as follows:

PROCEDURE proc_GetListDataLinks(

@SiteId uniqueidentifier, @WebId uniqueidentifier, @FirstDirName nvarchar(256), @FirstLeafName nvarchar(128), @FirstLevel tinyint, @LastDirName nvarchar(256), @LastLeafName nvarchar(128), @LastLevel tinyint, @GetWebListForNormalization bit,

@RequestGuid uniqueidentifier = NULL OUTPUT );

@SiteId: The site collection identifier of the site collection which contains the specified list (1).

@WebId: The site identifier of the site (2).

@FirstDirName: First allowable directory name to be returned, in alphabetic order.

@FirstLeafName: First allowable leaf name to be returned, in alphabetic order. This does not have to be a member of the directory @FirstDirName.

@FirstLevel: First allowable publishing level to be returned, in numeric order. The level does not have to be the level of a leaf in the directory @FirstDirName.

@LastDirName: Last allowable directory name to be returned, in alphabetical order.

@LastLeafName: Last allowable Leaf name to be returned, in alphabetical order. This does not have to be a member of the directory @LastDirName.

@LastLevel: Last allowable publishing level to be returned, in numeric order. This level does not have to be the level of a leaf in the directory @LastDirName.

@GetWebListForNormalization: Bit flag indicating that Web List For Normalization Result Set (section 3.1.4.58.1) MUST be returned.

@RequestGuid: The optional request identifier for the current request.

Return Code Values: An integer that the protocol client MUST ignore.

Result Sets: Conditionally returns the Web List For Normalization Result Set if the

@GetWebListForNormalization flag is set to 1, and MUST return the List Data Link Information Result Set (section 3.1.4.58.2).

3.1.4.58.1 Web List For Normalization Result Set

If the @GetWebListForNormalization flag is set to 1, the Web List For Normalization Result Set returns a list of URLs for subsites of the specified site collection. This will be an empty result set if there are no subsites in the site collection. The T-SQL syntax for the result set is as follows:

FullUrl nvarchar(256);

FullUrl: Full URL of a subsite in the site collection.

3.1.4.58.2 List Data Link Information Result Set

The List Data Link Information Result Set returns the list of dirty field (1) links for a range of list items in a site (2), sorted alphabetically from (@FirstDirName, @FirstLeafName, @FirstLevel) to (@LastDirName, @LastLeafName, @LastLevel), inclusive of the endpoints. This result set returns only rows where FieldId is not NULL, and contains zero or more rows. The result set is defined using T-SQL syntax as follows:

DirName nvarchar(256), LeafName nvarchar(128), Level tinyint,

FieldId uniqueidentifier, TargetDirName nvarchar(256), TargetLeafName nvarchar(128), Type tinyint, Security tinyint, Dynamic tinyint, ServerRel bit, Type tinyint, PointsToDir bit;

DirName: The directory name of the directory containing the source object of the link. This value MUST NOT be NULL.

LeafName: The leaf name of the source object.

Level: The Publishing Level Type value (see [MS-WSSFO2] section 2.2.2.6) defining the publishing level of the source object.

FieldId: The field identifier of the source object. This value MUST NOT be NULL.

TargetDirName: The directory name of the directory containing the target object of the link. This value MUST NOT be NULL.

TargetLeafName: The leaf name of the linked object. This value MUST NOT be NULL.

Type: Type of the link. The value MUST be one of the values described in the following table.

Value Description

"A" The link is from the ACTION attribute of an HTML form tag.

"B" The link is from the attribute markup of a bot.

"C" The link is from an auto-generated table of contents. Agents can ignore the link type when determining unreferenced files within a site (2).

"D" The link references programmatic content, as in the HTML OBJECT or APPLET tags.

"E" The link is from a cascading style sheet (CSS).

"F" The link is from the SRC attribute of an HTML FRAME tag.

"G" The link is to a dynamic Web template for the containing document.

"H" The link is from an HTML HREF attribute. This can also be used as a default link type value if a more precise type does not apply.

Value Description

"I" The link is to a document that the containing document includes via an include bot.

"J" The link is from a field (1) of this list item.

"K" Identical to "H", except that the link also specifies an HTML bookmark.

"L" The link is a target in an HTML image map generated from an image map bot.

"M" The link is to an image used in an HTML image map generated from an image map bot.

"O" The link is part of a cross-page URL connection.

"P" The link is part of the markup of a URL within the source of the containing document.

"Q" The link references a CSS document that provides style information for the containing document.

"R" The link is from the master page file attribute of the @Page directive in the containing document.

"S" The link is from an HTML SRC attribute.

"T" The link is to the index file used by a text search bot on this Web page.

"V" The link is based on the properties of the document, rather than anything in the document stream. The link type is used in tracking the link between a site (2) and the master page URL used for the site (2).

"X" The link is from an XML island within an HTML document.

"Y" The link references an HTML document whose HTML BODY tag attributes are used as a template for the attributes of the containing document's BODY tag.

"Z" The link is part of the markup of a URL that exists in a URL zone in the containing document, and is consequently not stored within the source of the containing document.

Security: Type of security for the link. The value MUST be one of the values in the following table.

Value Description

"H" The link is to an "HTTP:" URL.

"S" The link is to an "HTTPS:" URL.

"T" The link is to an "SHTTP:" URL.

"U" The link transport security is unknown.

Dynamic: A 1-byte (tinyint) value represented as a single upper case ASCII character that specifies the special link types. The value MUST be one of the values in the following table.

Value Description

"S" The URL is static, which is the default, and requires no special handling.

"D" The URL is dynamic, which is a link to <Site URL>/_vti_bin/shtml.dll/DirName/LeafName. Such links are used to call the SmartHTML interpreter on a file.

"L" The URL is to a layouts page. In other words, it contains a path segment with the string

Value Description

"_layouts".

"H" The URL is a history link. In other words, it contains a path segment with the string

"_vti_history".

"G" A non-absolute link from an uncustomized document that does not fall into any other category.

ServerRel: A bit flag that specifies whether the link URL is a server-relative URL. A value of "1"

specifies a server-relative URL. This value MUST NOT be NULL.

Type: Type of the linked object. This value MUST be one of the values in the following table.

Value Description

"0" File

"1" Directory

"2" Site (2)

"128" Backward link

PointsToDir: MUST be "1" if the link is to a directory. Otherwise, it MUST be zero ("0"). This value MUST NOT be NULL.