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

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

This procedure returns a document at the specified position in the tree.

Namespace: ContentStudio.Document.IndexedTree
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetAbsolute(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	int index,
	out bool isEof
)

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
ID of document to navigate from, this can be any document in the tree
index
Type: SystemInt32
Index of the position to find. This index is zero based.
isEof
Type: SystemBoolean
Returns true if there are no matching documents

Return Value

Type: String
XML
Copy
<root>
  <status>success></status>
  <statustext>Success</statustext>
  <documents iseof="0" treeid="1110" count="1" treemembers="200">
    <document documentid="1111" parent="1110" level="1" position="3" index="3" children="6" siblings="3" documentname="MyDocument" label="" norootlabel="" />
  </documents>
</root>
Exceptions
ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
CSDocumentNotFoundExceptionThe document could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
All users can successfully execute this method.
See Also

Reference

IndexedTreeNavigator Class
GetAbsolute Overload
ContentStudio.Document.IndexedTree Namespace