Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
A String that contains the document's file name.
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.
[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
public string GetBrowseableFilename( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, Nullable<DateTime> previewDate )
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. - previewDate
- 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.
Return Value
Type: StringA String that contains the document's file name.
Exceptions
Exception | Condition | ||||
---|---|---|---|---|---|
CSException |
A business rule was violated in the underlying Content Studio database
| ||||
CSPermissionDeniedException | The caller has no permission to perform the requested action | ||||
CSInvalidSessionException | The session is invalid | ||||
CSDocumentNotFoundException | The document could not be found | ||||
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Remarks
See Also