DocumentId.FindUrlById Method (Microsoft.Office.DocumentManagement)

FindUrlById Method

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

DocumentId..::.FindUrlById Method

Finds the URL of a document with the specified DocumentId value and versionLabel parameter value.

Namespace: Microsoft.Office.DocumentManagement
Assembly: Microsoft.Office.DocumentManagement (in Microsoft.Office.DocumentManagement.dll)

Syntax

Visual Basic (Declaration)

Public Shared Function FindUrlById ( _
    site As SPSite, _
    docId As String, _
    versionLabel As String _
) As String

Visual Basic (Usage)

Dim site As SPSite
Dim docId As String
Dim versionLabel As String
Dim returnValue As String

returnValue = DocumentId.FindUrlById(site, _
    docId, versionLabel)

public static string FindUrlById(
    SPSite site,
    string docId,
    string versionLabel
)

Parameters

site: Type: Microsoft.SharePoint..::.SPSite
ID to search for

docId: Type: System..::.String
SPSite object to search on

versionLabel: Type: System..::.String
Version of the label of the document for which to get the URL

Return Value

Type: System..::.String
URL of the document as a String. nullNothingnullptra null reference (Nothing in Visual Basic) if the document is not found, or if more than one document is found

Exceptions

Exception	Condition
ArgumentNullException	SPSite object value is set to nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

If there is more than one result, this method will return nullNothingnullptra null reference (Nothing in Visual Basic). In that case, use the FindUrlsById()()() method.

Reference

DocumentId Class

DocumentId Members

Microsoft.Office.DocumentManagement Namespace

FindUrlsById(SPSite, String)