Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
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.
[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, bool sortFromRoot, out int recordCount )
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 - sortFromRoot
- Type: SystemBoolean
Set to true to have the list sorted from the root and downwards - recordCount
- Type: SystemInt32
On output this parameter is filled with the number of documents found.
Return Value
Type: StringXml
Examples
<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
See Also