SearchResultsItem Class

Information about a document retrieved in a search.

dtSearch.Engine.SearchResultsItem

public class SearchResultsItem;

Remarks

SearchResultsItem is returned through the OnFound callback in ISearchSearchStatusHandler, and from SearchResults.

Information returned through OnFound will be incomplete if the dtsSearchDelayDocInfo flag was used in the search, because the callback is called without reading document information records from the index.

Topics

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

SearchResultsItem Methods

SearchResultsItem Methods	Description
GetUserField	Retrieve a stored field value for this document.
SetItemScore	Use to change the raw score of an item in SearchResults in the OnFound callback.

SearchResultsItem Properties

SearchResultsItem Properties	Description
Created	Creation date of the document (UTC)
DisplayName	If non-blank, a user-friendly name to display for the document (for example, the title of an HTML document).
DocId	An integer that uniquely identifies each document in an index.
Filename	Name of the document as it is stored in the index.
HitCount	Number of hits found in this document.
HitDetails	Details on words matched in this document.
Hits	Word offsets of hits found in this document.
HitsByWord	By-word summary of hits found in this document.
IndexRetrievedFrom	Full path to the index this document was found in.
IndexedBy	dtSearch Engine build number used to index this document
Location	The folder where the document is located.
Modified	Modification date of the document (UTC)
PhraseCount	Number of hits in this document, counting each phrase as one hit. This is only available if the dtsSearchWantHitsByWord flag was set in SearchJob.SearchFlags.
Score	Relevance score for this document.
ScorePercent	Relevance score for this document, expressed as a percentage (0-100) of the highest-scoring document in the search.
ShortName	The name of the document, without the path.
Size	Size of this document when it was indexed.
Synopsis	Hits-in-context string from SearchReportJob.
Title	The first 80 text characters of the document.
TypeId	Type id of the document
UserFields	Field-value pairs found in this document when the document was indexed.
VetoThisItem	Use to prevent an item from being added to SearchResults in the OnFound callback.
WhichIndex	Integer identifying the index that the document was retrieved from, in the IndexesToSearch array
WordCount	Number of words in this document when it was indexed.