SphinxClientBuildExcerpts Method (IEnumerableString, String, String, BuildExcerptsOptions)

Builds excerpts for the given documents using the settings from the given index name and the given options.

Namespace: SphinxConnector.NativeApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 5.4.1

Syntax

public IList<string> BuildExcerpts(
	IEnumerable<string> documents,
	string indexName,
	string highlightWords,
	BuildExcerptsOptions options
)

Public Function BuildExcerpts ( 
	documents As IEnumerable(Of String),
	indexName As String,
	highlightWords As String,
	options As BuildExcerptsOptions
) As IList(Of String)

Parameters

documents: Type: System.Collections.GenericIEnumerableString
The documents to build excerpts for.
indexName: Type: SystemString
The name of the index to use settings from.
highlightWords: Type: SystemString
The highlightWords to highlight.
options: Type: SphinxConnector.NativeApiBuildExcerptsOptions
The options to use when building excerpts.

Return Value

Type: IListString
A list of strings with the excerpts.

Exceptions

Exception	Condition
ArgumentException	documents does not contain any elements or indexName is empty.
ArgumentNullException	One of documents, indexName or options is null.
SphinxClientException	An error occured while executing the request. See exception message and inner exception for details.

Reference

SphinxClient Class

BuildExcerpts Overload

SphinxConnector.NativeApi Namespace