IDocumentWebService.GetDocumentsByPath Method

IDocumentWebService GetDocumentsByPath Method

Ankiro Enterprise Suite Reference Documentation

Retrieves information about a set of documents associated with a specific data source. Retrieved documents are limited to the set of documents that are contained within a specified part of the data source path segment tree.

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

IList<IndexDocumentData> GetDocumentsByPath(
	int dataSourceId,
	string pathSegmentForeignId,
	bool includeChildPaths,
	int offset,
	int count,
	bool includeData
)

IList<IndexDocumentData> GetDocumentsByPath(
	int dataSourceId,
	string pathSegmentForeignId,
	bool includeChildPaths,
	int offset,
	int count,
	bool includeData
)

Parameters

dataSourceId: Type: System Int32
The id of the data source for which to return document data.

pathSegmentForeignId: Type: System String
The foreign id of the path segment from which to retrieve documents. A null argument is valid, and signifies the root path of the data source.

includeChildPaths: Type: System Boolean
True to include documents that are contained in path segments descending from the base path segment, false otherwise.

offset: Type: System Int32
Logical offset of the first document to return in comparion to the total set of documents associated with the data source. (zero-offset)

count: Type: System Int32
The maximum number of documents to return. The number of returned documents may be less, if the data source contains fewer than [offset+count] documents.

includeData: Type: System Boolean
If true, the property values of returned documents are returned as well. When specifying this option, the count property should generally be a manageable number, e.g. <= 100.

Return Value

Type: IList IndexDocumentData