DocumentBrowserGetBrowseableFilename Method (ConnectionId, SessionId, DocumentId, NullableDateTime, 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)

public string GetBrowseableFilename(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	Nullable<DateTime> previewDate,
	out int categoryId


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value typically is retrieved from a call to the OpenSession method
Type: ContentStudio.DocumentDocumentId
An identifier of the document to get the file name for. This document must exist.
Type: SystemNullableDateTime
A value that specifies when there is a need to preview the document at a specific time, use null (Nothing in Visual Basic) to specify the current date and time.
Type: SystemInt32
When this method returns, categoryId contains the CategoryId for the current document. This parameter is passed uninitialized.

Return Value

Type: String
A String that contains the document's file name.

CSException A business rule was violated in the underlying Content Studio database
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.

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