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

DocumentReaderGetChildDocumentsTreeReverse 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.]

Returns a parent-child chain from a certain document up to the ultimate parent document.

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

Syntax

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

Public Function GetChildDocumentsTreeReverse ( 
	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 child document to start navigating from
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="2145" />
    <document id="2147" />
    <document id="2148" />
    <!-- more documents 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 document in the tree
/root/documents/document@id	integer	The document's identifier

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 every document in the chain is required. If a document without this permission is found the method stops traversion the chain at that point an returns the result so far.

Remarks

This overloaded implementation returns the list in the default sort order which starts from the child up to the root.

Reference

DocumentReader Class

GetChildDocumentsTreeReverse Overload

ContentStudio.Document Namespace