HighlightSearchResults
- class HPS.HighlightSearchResults : public HPS.Object
The HighlightSearchResults class is a smart-pointer to a database object. It contains the results of a FindHighlights operation.
Public Functions
- void Assign (HPS.HighlightSearchResults in_search_results)
Share the underlying smart-pointer if the assignment source. This method is functionally equivalent to the overloaded assignment operator except for the return value.
- Param in_search_results
The source of the assignment.
- override void Dispose ()
- ulong GetCount ()
Gets the number of items that were found in the associated search.
- Return
The number of unique items found.
- HPS.HighlightSearchResultsIterator GetIterator ()
Returns a HighlightSearchResultsIterator used to iterate through the found search results.
- Return
An iterator pointing to the beginning of the search results list.
- HighlightSearchResults ()
- HighlightSearchResults (HPS.HighlightSearchResults in_search_results)
The copy constructor creates a new HighlightSearchResults object that shares the underlying smart-pointer of the source.
- Param in_search_results
The source of the copy.
- override HPS.Type ObjectType ()
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- override void Reset ()
Resets this object to its initial, uninitialized state.
