DocumentEncoding.GetForDocument Method (ConnectionId, SessionId, DocumentId, Int32, String)

DocumentEncodingGetForDocument Method (ConnectionId, SessionId, DocumentId, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets the encoding for an object

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

Syntax

public string GetForDocument(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	out int status,
	out string statusText
)

Public Function GetForDocument ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As String

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).
documentId: Type: ContentStudio.DocumentDocumentId
The id of a document to return encoding for
status: Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText: Type: SystemString
The textual representation of the call result.

Return Value

Type: String
XML: syntax

Copy

<root><encoding>ENCODING</encoding></root>

Remarks

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.

Reference

DocumentEncoding Class

GetForDocument Overload

ContentStudio.Document Namespace