ISearchResults Interface

File

File: dten600.idl

Module: COM Interface

Syntax

IDL

interface ISearchResults : IDispatch;

Group

Members

Properties

Property	Description
Count	Number of items in search results
DocDetails	A string containing field information associated with a document.
DocHitCount	Number of hits found in the currently selected document
DocHits	A string containing the word offsets of the hits found in the currently selected document. For information on using this data to highlight hits, see "Highlighting Hits".
DocName	Name of the currently selected document in the search results set.
Request	The search request that generated these results
TotalHitCount	Returns the number of hits in all files retrieved in the search, which may be more than the number actually stored in search results

Methods

Method	Description
AddDoc	Add a specific document from an index to the search results list. docId is a document id identifying the document to add. hits is an array of integers containing the word offsets of the hits for this document. See the IndexInfo.vbs sample for an example of how AddDoc can be used.
DocDetailItem	Extracts one item from the DocDetails list
Empty	Remove all items from a search results list (this immediately frees memory needed for the items)
GetNthDoc	Select one item in search results. This fills the DocName, DocDetails, etc. properties with the values for this item
MakePdfWebHighlightFile	MakePdfWebHighlightFile generates xml data used to highlight hits in Adobe Reader through a web browser interface.
NewSearchReportJob	Generate a SearchReportJob (ISearchReportJob) to generate a search report based on this set of search results.
SerializeAsXml	SerializeAsXml generates a stream of XML containing data in the search results list. SerializeFromXml reverses the process and fills a SearchResults object with data from an XML stream.
SerializeFromXml	SerializeFromXml fills a SearchResults object with data from an XML stream. Parameters
SetSortKey	Specify the string value to use when sorting search results.
Sort	Sort search results. See SortFlagsDts for sorting options.
UrlDecodeItem	Decodes a URL created by UrlEncodeItem
UrlEncodeItem	UrlEncodeItem creates a url-encoded string describing the currently-selected item in search results.

Methods

Method	Description
AddDoc	Add a specific document from an index to the search results list. docId is a document id identifying the document to add. hits is an array of integers containing the word offsets of the hits for this document. See the IndexInfo.vbs sample for an example of how AddDoc can be used.
DocDetailItem	Extracts one item from the DocDetails list
Empty	Remove all items from a search results list (this immediately frees memory needed for the items)
GetNthDoc	Select one item in search results. This fills the DocName, DocDetails, etc. properties with the values for this item
MakePdfWebHighlightFile	MakePdfWebHighlightFile generates xml data used to highlight hits in Adobe Reader through a web browser interface.
NewSearchReportJob	Generate a SearchReportJob (ISearchReportJob) to generate a search report based on this set of search results.
SerializeAsXml	SerializeAsXml generates a stream of XML containing data in the search results list. SerializeFromXml reverses the process and fills a SearchResults object with data from an XML stream.
SerializeFromXml	SerializeFromXml fills a SearchResults object with data from an XML stream. Parameters
SetSortKey	Specify the string value to use when sorting search results.
Sort	Sort search results. See SortFlagsDts for sorting options.
UrlDecodeItem	Decodes a URL created by UrlEncodeItem
UrlEncodeItem	UrlEncodeItem creates a url-encoded string describing the currently-selected item in search results.

Properties

Property	Description
Count	Number of items in search results
DocDetails	A string containing field information associated with a document.
DocHitCount	Number of hits found in the currently selected document
DocHits	A string containing the word offsets of the hits found in the currently selected document. For information on using this data to highlight hits, see "Highlighting Hits".
DocName	Name of the currently selected document in the search results set.
Request	The search request that generated these results
TotalHitCount	Returns the number of hits in all files retrieved in the search, which may be more than the number actually stored in search results

Description

Provides access to the results of a search

Remarks

To create a SearchResults object containing the results of a search,

Set up a SearchJob to perform the search.
Set the ResultsInMemory property of the SearchJob to true.
Set the MaxFilesToRetrieve property to the maximum size of the SearchResults set.
Execute the SearchJob.
After the search is complete, use the Results property of the SearchJob to get a copy of the search results.

Because SearchJob.Results returns a copy of the results, to access the Results property after a search, use a temporary variable, like this:

    Dim r as SearchResults
    Set r = searchJob.Results

Class Hierarchy

ISearchResults