SearchResultsIterator
- class HPS.SearchResultsIterator : public HPS.Object
An iterator used for traversing results from a search on an associated SearchResults object.
Public Functions
- override void Dispose ()
- HPS.Key GetItem ()
Returns the item that this iterator is currently pointing at. Throws exception if iterator is not valid. This method is functionally equivalent to the overloaded operator*.
- Return
The current item.
- HPS.Search.Type[] GetResultTypes ()
Retrieves the search criteria that were met for the current search item pointed to by this iterator.
- Return
An array of search types for the current item.
- bool IsValid ()
Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element.
- Return
true if this iterator is pointing to a valid item, false otherwise.
- void Next ()
Advances the iterator to the next search result item
- 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 iterator to the beginning of the associated search results.
- SearchResultsIterator ()
The default constructor creates a new SearchResultsIterator object that is not associated with any SearchResults object.
- SearchResultsIterator (HPS.SearchResultsIterator in_search_results_iterator)
The copy constructor initializes a new SearchResultsIterator object that is associated with the same SearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other.
- Param in_search_results_iterator
The source of the copy.
- void Set (HPS.SearchResultsIterator in_search_results_iterator)
Copies a SearchResultsIterator object, associating this object with the same SearchResults object as the source and at the same location in the results. Subsequent changes to either iterator will not affect the other. This method is functionally equivalent to the overloaded assignment operator except for the return value.
- Param in_search_results_iterator
The source of the copy.
