DocumentReaderGetDocumentIdentifierFromRelativeURL Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Obtains the identifier for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public int GetDocumentIdentifierFromRelativeURL(
	ConnectionId connectionId,
	SessionId sessionId,
	string documentPath
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
documentPath
Type: SystemString
The document's relative url.

Return Value

Type: Int32
If found, an identifier of the found document; otherwise zero.
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

BROWSE permission on the document is required. This method supports anonymous calls
Remarks

This method is identical to the GetDocumentFromRelativeURL(ConnectionId, SessionId, String) method except for the fact that this method returns and integer instead of an Xml document.
See Also

Reference