IndexedTreeManager.CreateIndex Method (ConnectionId, SessionId, DocumentId)

IndexedTreeManagerCreateIndex Method (ConnectionId, SessionId, DocumentId)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Creates an indexed document tree from the root document. The document must be a root document. If the index already it will be dropped and re-created.

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

Syntax

Copy

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

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

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 document that will be the root document of the index

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

Write permission on the root document is required.

Reference

IndexedTreeManager Class

CreateIndex Overload

ContentStudio.Document.IndexedTree Namespace