DocumentManager.CreateBinary Method (ConnectionId, SessionId, String, String, Int32, String)

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

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Creates a new binary document. The document can only be created in a category for binary documents (uploaded files). This methods supports anonymous callers.

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

Syntax

Copy

public virtual int CreateBinary(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out string retFileName,
	out int status,
	out string statusText
)

Public Overridable Function CreateBinary ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef retFileName As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
) As Integer

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
retFileName: Type: SystemString
Returns the relative filename of the document.
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: Int32
The id of the created document

Content Studio permissions

Create/Write permission on the category is required. Some of the properties that involve publishing rules like Published or PublishDate require Approve permission on the document. If the caller lacks this permission these fields are ignored. Additionally, if workflow is applicable, workflow rules will apply as well.
The caller must have the WriteActiveContent global right set on at least of her groups in order to upload restricted file types. For a list of restricted file extensions see the the WriteActiveContent global right.

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

DocumentManager Class

CreateBinary Overload

ContentStudio.Document Namespace