REFERENCE MANUAL
An iterator used for traversing results from a search on an associated SearchResults object. More...
Public Member Functions | |
override void | Dispose () |
HPS.Key | GetItem () |
Returns the item that this iterator is currently pointing at. More... | |
HPS.Search.Type[] | GetResultTypes () |
Retrieves the search criteria that were met for the current search item pointed to by this iterator. More... | |
bool | IsValid () |
Queries the validity of this iterator location. More... | |
void | Next () |
Advances the iterator to the next search result item More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
override void | Reset () |
Resets iterator to the beginning of the associated search results. More... | |
SearchResultsIterator () | |
The default constructor creates a new SearchResultsIterator object that is not associated with any SearchResults object. More... | |
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. More... | |
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. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
An iterator used for traversing results from a search on an associated SearchResults object.
HPS.SearchResultsIterator.SearchResultsIterator | ( | ) |
The default constructor creates a new SearchResultsIterator object that is not associated with any SearchResults object.
HPS.SearchResultsIterator.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.
in_search_results_iterator | The source of the copy. |
HPS.Key HPS.SearchResultsIterator.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*.
HPS.Search.Type [] HPS.SearchResultsIterator.GetResultTypes | ( | ) |
Retrieves the search criteria that were met for the current search item pointed to by this iterator.
bool HPS.SearchResultsIterator.IsValid | ( | ) |
Queries the validity of this iterator location.
Invalid locations would include uninitialized iterators and iterators that had walked past the last element.
void HPS.SearchResultsIterator.Next | ( | ) |
Advances the iterator to the next search result item
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
virtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS.Object.
void HPS.SearchResultsIterator.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.
in_search_results_iterator | The source of the copy. |