Links
dtSearch Text Retrieval Engine Programmer's Reference 7.70
ISearchResults Interface
dten600.idl | Interfaces | Legend | Members | Methods | Properties | Send Feedback

Provides access to the results of a search

Class Hierarchy
[ object, uuid(798CBE34-B27D-11D3-B57C-00105AA461D0), dual, helpstring("ISearchResults Interface"), pointer_default(unique) ]
interface ISearchResults : IDispatch;
File
Remarks

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

  1. Set up a SearchJob to perform the search.
  2. Set the ResultsInMemory property of the SearchJob to true.
  3. Set the MaxFilesToRetrieve property to the maximum size of the SearchResults set.
  4. Execute the SearchJob.
  5. 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
Group
Methods
Method 
Description 
Add a specific document from an index to the search results list. 
Extracts one item from the DocDetails list 
Remove all items from a search results list (this immediately frees memory needed for the items) 
Select one item in search results. 
MakePdfWebHighlightFile generates xml data used to highlight hits in Adobe Reader through a web browser interface. 
Generate a SearchReportJob (ISearchReportJob) to generate a search report based on this set of search results. 
SerializeAsXml generates a stream of XML containing data in the search results list. 
SerializeFromXml fills a SearchResults object with data from an XML stream. 
Specify the string value to use when sorting search results. 
Sort 
Sort search results. 
Decodes a URL created by UrlEncodeItem 
UrlEncodeItem creates a url-encoded string describing the currently-selected item in search results. 
Properties
Property 
Description 
Number of items in search results 
A string containing field information associated with a document. 
Number of hits found in the currently selected document 
A string containing the word offsets of the hits found in the currently selected document. 
Name of the currently selected document in the search results set. 
The search request that generated these results 
Returns the number of hits in all files retrieved in the search, which may be more than the number actually stored in search results 
Legend
 
Property 
 
read only 
 
Method 
Links
You are here: COM Interface > Interfaces > ISearchResults Interface
Copyright (c) 1995-2012 dtSearch Corp. All rights reserved.