DocumentManagerCheckOut Method (ConnectionId, SessionId, DocumentId, Boolean) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Checks out a document for editing. This methods supports anonymous callers.

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

public void CheckOut(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	out bool contentWasCreated
)

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 document to check out
contentWasCreated
Type: SystemBoolean
After the call this parameter indicates whether a new content was created or not.
Exceptions

ExceptionCondition
CSException
  • 1001 - Session is invalid
  • 1002 - Permission denied
  • 1804 - The document could not be found.
  • 1809 - The document is already checked out by %UserName%
  • 1811 - The document is protected.
  • 1820 - Can not check out the document. It has been sent for revision by %USERNAME%
  • 2115 - Workflow: Action not available for the caller.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

WRITE permission on the document is required. If workflow is involved Content Studio Workflow Server will require permission to check out in the workflow as well.
See Also

Reference