DocumentReader.GetChildDocuments Method (ConnectionId, SessionId, DocumentId, Int32)

DocumentReaderGetChildDocuments Method (ConnectionId, SessionId, DocumentId, Int32)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets all child documents for a certain document.

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

Syntax

public string GetChildDocuments(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	out int recordCount
)

Public Function GetChildDocuments ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	<OutAttribute> ByRef recordCount As Integer
) 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
An identifier to a parent document whose child documents should be listed
recordCount: Type: SystemInt32
On output this parameter is filled with the number of documents found.

Return Value

Type: String
Xml

Examples

Copy

<root>
   <status>integer value</status>
   <statustext>string value</statustext>
   <documents>
       <document id="integer value" 
                    name="string value" 
                    child="bit value" 
                    parentid="integer value" 
                    cid="integer value" 
                    type="string value" 
                    deleted="bit value">
         <category module="string value" />
       </document>
       <!-- more document can follow -->
   </documents>
</root>

Element/attribute	Type	Description
/root/status	integer	Indicates the outcome of the call; always 0 (success)
/root/statustext	string	The textual outcome of the call; always Success
/root/documents/document	---	An element representing one single child document
/root/documents/document@id	integer	The document's identifier
/root/documents/document@name	string	The name of the document
/root/documents/document@child	bit (0 \| 1)	1 if the document has child documents; otherwise, 0
/root/documents/document@parentid	integer	The identifier of the parent document.
/root/documents/document@cid	integer	The category id of the document
/root/documents/document@type	string	The content type (mime type) of the document
/root/documents/document@deleted	bit (0 \| 1)	1 if the document is deleted; otherwise, 0
/root/documents/document/category@module	string	The name of the document module. See ModuleName for information about the meaning of this value.

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READ permission on the parent document is required.

Reference

DocumentReader Class

GetChildDocuments Overload

ContentStudio.Document Namespace