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

Namespace: Gronewold.SphinxConnector
Assembly: Gronewold.SphinxConnector (in Gronewold.SphinxConnector.dll) Version: 2.8.0.26312 (2.8.0.26312)

Syntax

C#
public IList<string> BuildExcerpts(
	IEnumerable<string> documents,
	string indexName,
	string highlightWords,
	BuildExcerptsOptions options
)
Visual Basic
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.Generic..::..IEnumerable<(Of <(<'String>)>)>
The documents to build excerpts for.
indexName
Type: System..::..String
The name of the index to use settings from.
highlightWords
Type: System..::..String
The highlightWords to highlight.
options
Type: Gronewold.SphinxConnector..::..BuildExcerptsOptions
The options to use when building excerpts.

Return Value

A list of strings with the excerpts.

Exceptions

ExceptionCondition
System..::..ArgumentExceptiondocuments does not contain any elements or indexName is empty.
System..::..ArgumentNullException One of documents, indexName or options is null.
Gronewold.SphinxConnector..::..SphinxClientException An error occured while executing the request. See exception message and inner exception for details.

See Also