The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it. More...
Public Member Functions | |
override void | Dispose () |
SelectionResultsIterator () | |
The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object. More... | |
SelectionResultsIterator (HPS.SelectionResultsIterator in_that) | |
The copy constructor creates a SelectionResultsIterator object associated with the same SelectionResults object as the source SelectionResultsIterator and at the same location in the results. Subsequent changes to either iterator will not affect the other. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.SelectionResultsIterator in_that) |
Copies the source SelectionResultsIterator into this SelectionResultsIterator. More... | |
void | Next () |
Advances the iterator to the next selection item. More... | |
bool | IsValid () |
Indicates whether this SearchResultsIterator is pointing to a valid selection item. More... | |
override void | Reset () |
Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object. More... | |
HPS.SelectionItem | GetItem () |
Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid. More... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it.
|
inline |
The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object.
|
inline |
The copy constructor creates a SelectionResultsIterator object associated with the same SelectionResults object as the source SelectionResultsIterator and at the same location in the results. Subsequent changes to either iterator will not affect the other.
in_that | The source SelectionResultsIterator object to copy. |
|
inline |
Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid.
|
inline |
Indicates whether this SearchResultsIterator is pointing to a valid selection item.
|
inline |
Advances the iterator to the next selection item.
|
inlinevirtual |
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.
|
inlinevirtual |
Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object.
Reimplemented from HPS.Object.
|
inline |
Copies the source SelectionResultsIterator into this SelectionResultsIterator.
in_that | The source SelectionResultsIterator to copy. |