IndexedTreeManagerIsIndexedDocument Method (ConnectionId, SessionId, String, String, Int32, String) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Checks if a document belongs to an indexed tree.

Namespace: ContentStudio.Document.IndexedTree
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public bool IsIndexedDocument(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out string returnedXmlData,
	out int status,
	out string statusText
)

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).
xmlParameterData
Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
returnedXmlData
Type: SystemString
After the call the ReturnedData output parameter is filled with an XML document that contains detailed data about the document and its tree.
status
Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText
Type: SystemString
The textual representation of the call result.

Return Value

Type: Boolean
True if the document is a member in a document tree index, false otherwise
Content Studio permissions
Delete permission on the root document is required.
Remarks
This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.
See Also

Reference

IndexedTreeManager Class
IsIndexedDocument Overload
ContentStudio.Document.IndexedTree Namespace