IndexedTreeManager.DeleteIndex Method (ConnectionId, SessionId, DocumentId)

IndexedTreeManagerDeleteIndex Method (ConnectionId, SessionId, DocumentId)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Deletes an element tree. The specified document must be a root document.

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

Syntax

public void DeleteIndex(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

Public Sub DeleteIndex ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId
)

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

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

Delete permission on the root document is required.