XmlIndexDataReIndexDocument Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Re-indexes EPT documents. This method is a part of the Content Studio base infrastructure and is not meant to be used outside Content Studio.

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

public int ReIndexDocument(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	int executeCount,
	int[] tagsToIndex,
	out int nextDocument
)

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 to save data for
executeCount
Type: SystemInt32
The number of documents to fetch in one batch before submitting them to Content Studio for re-indexing.
tagsToIndex
Type: SystemInt32
An array of tag id:s, valid for this document, that should be indexed.
nextDocument
Type: SystemInt32
Returns the next document to be indexed. This parameter returns zero if no more documents to index exists.

Return Value

Type: Int32
The number of saved Xml data tags for all documents. This is a combination of both the draft and the approved data tags indexed.
Exceptions

ExceptionCondition
CSDocumentNotFoundExceptionThe document does not exist
CSExceptionA business rule was violated in the underlying Content Studio database.

Exception numbers can be

Exception numbers
NumberDescription
1001Invalid session ID
1002Permission denied
1009Invalid parameter value
1805The document does not support this functionality
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

The user calling this method must have the ServiceQueueAdmin user right.
See Also

Reference