DocumentBrowserGetBrowseableFilename Method (ConnectionId, SessionId, DocumentId, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns the file that represents a published Content Studio document.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetBrowseableFilename(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	out int categoryId
)

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 typically is retrieved from a call to the OpenSession method
documentId
Type: ContentStudio.DocumentDocumentId
An identifier of the document to get the file name for. This document must exist.
categoryId
Type: SystemInt32
Returns the category id for the current document

Return Value

Type: String
A String that contains the document's file name.
Exceptions
ExceptionCondition
CSException A business rule was violated in the underlying Content Studio database
NumberDescription
1838The document does not exist
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSDocumentNotFoundExceptionThe document could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
BROWSE permission on the document is required.
Remarks
This method is a very fast way of retrieving the file name of a published Content Studio document. The file name can be used to read the content of the document directly from disc.
See Also

Reference

DocumentBrowser Class
GetBrowseableFilename Overload
ContentStudio.Document Namespace