DocumentReader.GetBinaryContent Method (ConnectionId, SessionId, String, Int32, String)

DocumentReaderGetBinaryContent Method (ConnectionId, SessionId, String, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns the content together with its size and type of a document. The content returned is Base64 binary data.

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

Syntax

public Stream GetBinaryContent(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText
)

Public Function GetBinaryContent ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As Stream

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).
xmlParameterData: Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
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: Stream

A stream containing xml. The caller must close the stream after the call.

Copy

<root>
    <status>Integer value</status>
    <statustext>String value</statustext>
    <content contenttype="String value" 
             size="Integer value"
             contentbinary="String value"
    />
</root>

The xml has the following elements and attributes.

Xml specification

Element	Attribute	Description
root/status		Indicates the outcome of the call. This value is always zero (0) which indicates success.
root/statustext		The textual representation of the call. This value is always "Success".
root/content		The element that contains the attributes containing the data.
root/content	contenttype	A value that contains the content type (Mime type) of the returned data.
root/content	size	A value that represents the size of the data.
root/content	contentbinary	The binary content. This value is a Base64 encoded data.

Content Studio permissions

READ permission on the document is required to read a draft and BROWSE for any approved content. This method supports anonymous users.

Reference

DocumentReader Class

GetBinaryContent Overload

ContentStudio.Document Namespace