IDocumentWebService.UpdateDataSourcePathSegment Method

IDocumentWebService UpdateDataSourcePathSegment Method

Ankiro Enterprise Suite Reference Documentation

Updates a specific path segment in the data source tree, non-recursively. If the specified path segment does not exist, but the parent exists, the segment is added to the tree of the parent segment. If the parent does not exist, an exception will be thrown.

Namespace: Ankiro.SearchServer.Web.Services
Assembly: Ankiro.SearchServer.Web (in Ankiro.SearchServer.Web.dll) Version: 1.13.770.19253 (1.13.770.19253)

Syntax

C++

Copy to Clipboard Print

void UpdateDataSourcePathSegment(
	int dataSourceId,
	DataSourcePathSegmentData segment,
	bool pruneChildren,
	bool deleteOrphanedDocuments,
	bool updateIncludeState
)

void UpdateDataSourcePathSegment(
	int dataSourceId,
	DataSourcePathSegmentData segment,
	bool pruneChildren,
	bool deleteOrphanedDocuments,
	bool updateIncludeState
)

Parameters

dataSourceId: Type: System Int32

segment: Type: Ankiro.SearchServer.Data DataSourcePathSegmentData

pruneChildren: Type: System Boolean
The method updates the path segment non-recursively, however, if pruneChildren is true, the Children collection of the specified path segment is used to prune pre-existing path segments. Any pre-existing child segment of the specified path segment that does not exist in the Children collection passed into the method, will be removed. If the path segment being updated did not exist before invoking the method, this setting has no effect. Children elements will not be created as a result of invoking this method.

deleteOrphanedDocuments: Type: System Boolean
If pruneChildren is true, deleteOrphanedDocuments controls whether documents belonging to deleted path segments are also removed. The method does not commit this change. Rather, Commit() or CommitFullUpdate() should be invoked subsequently to complete the document deletion.

updateIncludeState: Type: System Boolean