HPS.HighlightSearchResults Class Reference
Inheritance diagram for HPS.HighlightSearchResults:

Public Member Functions

void Assign (HPS.HighlightSearchResults in_search_results)
override void Dispose ()
ulong GetCount ()
HPS.HighlightSearchResultsIterator GetIterator ()
 HighlightSearchResults (HPS.HighlightSearchResults in_search_results)
override HPS.Type ObjectType ()
override void Reset ()
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
IntPtr GetClassID ()
IntPtr GetInstanceID ()
bool HasType (HPS.Type in_mask)
Object (HPS.Object that)
virtual HPS.Type Type ()

Protected Member Functions

override void deleteCptr ()
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
- Protected Attributes inherited from HPS.Object
bool cMemOwn
HandleRef cptr

Detailed Description

The HighlightSearchResults class is a smart-pointer to a database object. It contains the results of a FindHighlights operation.

Constructor & Destructor Documentation

◆ HighlightSearchResults()

HPS.HighlightSearchResults.HighlightSearchResults ( HPS.HighlightSearchResults  in_search_results)

The copy constructor creates a new HighlightSearchResults object that shares the underlying smart-pointer of the source.

in_search_resultsThe source of the copy.

Member Function Documentation

◆ Assign()

void HPS.HighlightSearchResults.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.

in_search_resultsThe source of the assignment.

◆ GetCount()

ulong HPS.HighlightSearchResults.GetCount ( )

Gets the number of items that were found in the associated search.

The number of unique items found.

◆ GetIterator()

HPS.HighlightSearchResultsIterator HPS.HighlightSearchResults.GetIterator ( )

Returns a HighlightSearchResultsIterator used to iterate through the found search results.

An iterator pointing to the beginning of the search results list.

◆ ObjectType()

override HPS.Type HPS.HighlightSearchResults.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).

The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ Reset()

override void HPS.HighlightSearchResults.Reset ( )

Resets this object to its initial, uninitialized state.

Reimplemented from HPS.Object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.HighlightSearchResults.cs