SearchResult Class

Ankiro Enterprise Suite Reference Documentation

The SearchResult class contains all information associated with a search result as e.g. obtained through the search web service.

Inheritance Hierarchy

System Object
Ankiro.SearchServer.Data.Search SearchResult
Ankiro.SearchServer.Data.Search PreviewSearchResult

Namespace: Ankiro.SearchServer.Data.Search
Assembly: Ankiro.SearchServer.Data (in Ankiro.SearchServer.Data.dll) Version: 1.13.770.19207 (1.13.770.19207)

Syntax

C++

Copy to Clipboard Print

public class SearchResult : IExtensibleDataObject

public class SearchResult : IExtensibleDataObject

The SearchResult type exposes the following members.

Constructors

	Name	Description
	SearchResult	Initializes a new instance of the SearchResult class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	Decorations
	Diagnostics	Diagnostic information for debug purposes.
	Documents	The set of result documents returned by the search query.
	EffectiveParameters	NOTE: This property is only used when custom server side processing of search parameters has been applied. The effectively used parameters after server side processing.
	EmptyResult
	ExtensionData
	GroupInfo	Optional grouping information for the search result, in case the search profile executed, specified one or more GroupBy constructs.
	GroupSummations	Optional group summation information for the search result, in case the search profile executed, specified one or more GroupSummation constructs.
	Offset	The logical offset of the first returned document in the search result. Offsets are specified at the time of search, using SearchParameters.Offset. .
	PreFacetInfo	When SearchParameters.FacetParameters contain one or more parameters, contains the group information and group summation information that would have been obtained _without_ the specified set of facet parameters. This can be useful when e.g. it is desired to display facet information for non-matched (due to facet limiters) facets - in other words, the set of documents the user is 'missing out on'.
	SearchId	The unique id of the search result as logged in the database when SearchParameters.LogSearch=true.
	SearchTime	Total time used in the search service to execute the search query. This number includes time spent logging the search.
	SpellcheckSuggestions	The set of spell check suggestions generated by the internal spellchecker, in case SearchParameters.SpellcheckSearchString=true.
	Timestamp	The timestamp of the execution of the search.
	TotalResults	Total number of results matched by the search query, irrespective of the number of documents returned. Inspect the size of the Documents collection to obtain the number of returned result documents.
	WeightThresholds
	XmlResult	If ReturnLegacySearchResult is specified on SearchParameters, then this property will contain a legacy XML search result.

Top