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)

'Declaration
Public Shared Function FindUrlById ( _
	site As SPSite, _
	docId As String, _
	versionLabel As String _
) As String
'Usage
Dim site As SPSite
Dim docId As String
Dim versionLabel As String
Dim returnValue As String

returnValue = DocumentId.FindUrlById(site, _
	docId, 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. a null reference (Nothing in Visual Basic) if the document is not found, or if more than one document is found

ExceptionCondition
ArgumentNullException

SPSite object value is set to a null reference (Nothing in Visual Basic).

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

Show: