More...
|
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*. 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. Invalid locations would include uninitialized iterators and iterators that had walked past the last element. 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 (if the object is derived, this does not give the true type of the derived object). 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. Subsequent changes to either iterator will not affect the other. 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. 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. More...
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
| Object (HPS.Object that) |
|
virtual HPS.Type | Type () |
| This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
|
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
An iterator used for traversing results from a search on an associated SearchResults object.
◆ SearchResultsIterator() [1/2]
HPS.SearchResultsIterator.SearchResultsIterator |
( |
| ) |
|
|
inline |
◆ SearchResultsIterator() [2/2]
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.
- Parameters
-
in_search_results_iterator | The source of the copy. |
◆ GetItem()
HPS.Key HPS.SearchResultsIterator.GetItem |
( |
| ) |
|
|
inline |
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*.
- Returns
- The current item.
◆ GetResultTypes()
Retrieves the search criteria that were met for the current search item pointed to by this iterator.
- Returns
- An array of search types for the current item.
◆ IsValid()
bool HPS.SearchResultsIterator.IsValid |
( |
| ) |
|
|
inline |
Queries the validity of this iterator location. Invalid locations would include uninitialized iterators and iterators that had walked past the last element.
- Returns
- true if this iterator is pointing to a valid item, false otherwise.
◆ Next()
void HPS.SearchResultsIterator.Next |
( |
| ) |
|
|
inline |
Advances the iterator to the next search result item
◆ ObjectType()
override HPS.Type HPS.SearchResultsIterator.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ Reset()
override void HPS.SearchResultsIterator.Reset |
( |
| ) |
|
|
inlinevirtual |
Resets iterator to the beginning of the associated search results.
Reimplemented from HPS.Object.
◆ Set()
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.
- Parameters
-
in_search_results_iterator | The source of the copy. |
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SearchResultsIterator.cs