3.1.4.43 proc_ListUrls

The proc_ListUrls stored procedure is invoked to get metadata for a document specified by a URL and the Documents contained within it, if any.

PROCEDURE proc_ListUrls(
      @DirSiteId                     uniqueidentifier,
      @DirWebId                      uniqueidentifier,
      @DirFullUrl                    nvarchar(260),
      @AttachmentsFlag               tinyint,
      @ClientTimeStamp               datetime,
      @FetchLinkInfo                 bit,
      @IncludeThicketDirs            bit,
      @IncludeListItems              bit,
      @UserId                        int
);

@DirSiteId: The Site Collection Identifier of the site collection containing the document specified by a URL.

@DirWebId: The Site Identifier of the site containing the document.

@DirFullUrl: The store-relative form URL specifying the document.

@AttachmentsFlag: An Attachments Flag value specifying whether the document is, or is contained within, a folder for attachments.

@ClientTimeStamp: A datetime that specifies a limiting time on the data in the result sets returned. See the description of the result sets below for the specific effects of this parameter value.

@FetchLinkInfo: A bit flag specifying whether to return the Link Info Result Set. If this parameter is set to 1 and the specified document is a folder, the Link Info Result Set MUST be returned.

@IncludeThicketDirs: A bit flag specifying whether to return thicket folders in the Contained Document Metadata Result Set. If this parameter is set to 1 and the specified document is a folder, any thicket folders MUST be included in the Contained Document Metadata Result Set.

@IncludeListItems: A bit flag specifying whether to include list items which are files in the Link Info Result Set and the Contained Document Metadata Result Set. If this parameter is set to 1 and the document is a folder, List Items with a Document Store Type of 0 (File) MUST be included in the Link Info Result Set and the Contained Document Metadata Result Set.

@UserId: The User Identifier for the current user.

Return Values: The proc_ListUrls stored procedure returns an integer return code that MUST be in the following table:

The proc_ListUrls stored procedure MUST return two to six result sets, as described below, in the following order: