SearchResults Class

List of documents retrieved in a search.

dtSearch.Engine.SearchResults

public class SearchResults : DisposableObject;

Remarks

After a search, SearchJob.Results will contain a SearchResults listing the documents found in the search.

To access information about each document, call GetNthDoc() to select the document in the list, then use CurrentItem to access its properties.

IDisposable

SearchResults requires the IDisposable Pattern.

Topics

Topic	Description
SearchResults Members	The following tables list the members exposed by SearchResults.
SearchResults Methods	The methods of the SearchResults class are listed here.
SearchResults Properties	The properties of the SearchResults class are listed here.

SearchResults Methods

SearchResults Methods	Description
AddDoc	Add a document to SearchResults.
AddDocs	Add documents to SearchResults.
Empty	Remove all items from the search results list.
GetNthDoc	Select a document in search results.
GetNthDoc	Obtain information about a document in search results.
IntersectionOf	Create a SearchResults object containing only those items that are present in two other SearchResults objects
MakePdfWebHighlightFile	Generates xml data used to highlight hits in Adobe Reader through a web browser interface.
SerializeAsXml	Generates a stream of XML containing data in the search results list.
SerializeFromXml	Fills a SearchResults object with data from an XML stream generated by SerializeAsXml
SetSortKey	Set the sort key for the currently-selected document.
Sort	Sorts the search results according to the value in flags, with an optional user-defined field name.
UnionWith	Combines search results with another search results object, eliminating duplicate items.
UrlDecodeItem	UrlDecodeItem converts a string created by UrlEncodeItem back into a search results item.
UrlDecodeItemWithIndex	UrlDecodeItemWithIndex converts a string created by UrlEncodeItem or UrlEncodeItemWithIndexId back into a search results item.
UrlEncodeItem	Creates a url-encoded string describing the currently-selected item in search results.
UrlEncodeItemWithIndexId	Creates a url-encoded string describing the currently-selected item in search results.

SearchResults Properties

SearchResults Properties	Description
Count	Number of documents in the list
CurrentItem	Properties of the currently-selected item
Request	The search request that generated this list of results
TotalHitCount	Total number of hits in all documents