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

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

Retrieves the MLC status for an MLC member document.

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

public string GetMemberStatus(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

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 retrieve MLC status for.

Return Value

Type: String
Xml
<root>
   <status>0</status>
   <statustext>Success</statustext>
   <mlcstatus role="2" languageid="1044" languagename="Norwegian - Bokmål" languagecode="no" masterdocumentid="3724" mlcmaster="513" masterdocumentname="Hello master!" />
</root>
The role attribute has the following possible values and meaning
RoleMeaning
0The document is not an MLC document
1The document is a master document
2The document is a member document
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
  • 1001 - The SessionID is invalid.
  • 1002 - Permission denied.
  • 1100 - The document does not exist.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

Read permission is required on the selected document.
See Also

Reference