Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
True if the document is a member in a document tree index, false otherwise
All users can execute this method.
[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
public bool IsIndexedDocument( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, out string returnedXmlData )
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
The root document that of the index to delete - 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.
Return Value
Type: BooleanTrue if the document is a member in a document tree index, false otherwise
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSPermissionDeniedException | The caller has no permission to perform the requested action |
CSInvalidSessionException | The session is invalid |
CSDocumentNotFoundException | The document could not be found |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also