The SearchResults class is a smart-pointer to a database object. It contains the results of a Find operation.
More...
|
void | Assign (HPS.SearchResults 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. More...
|
|
override void | Dispose () |
|
ulong | GetCount () |
| Gets the number of items that were found in the associated search. More...
|
|
HPS.SearchResultsIterator | GetIterator () |
| Returns a SearchResultsIterator used to iterate through the found search results. 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...
|
|
override void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
| SearchResults (HPS.SearchResults in_search_results) |
| The copy constructor creates a new SearchResults object that shares the underlying smart-pointer of the source. 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. 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) |
|
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 |
|
HandleRef | scptr |
|
The SearchResults class is a smart-pointer to a database object. It contains the results of a Find operation.
The copy constructor creates a new SearchResults object that shares the underlying smart-pointer of the source.
- Parameters
-
in_search_results | The source of the copy. |
Share the underlying smart-pointer if the assignment source. This method is functionally equivalent to the overloaded assignment operator except for the return value.
- Parameters
-
in_search_results | The source of the assignment. |
ulong HPS.SearchResults.GetCount |
( |
| ) |
|
|
inline |
Gets the number of items that were found in the associated search.
- Returns
- The number of unique items found.
Returns a SearchResultsIterator used to iterate through the found search results.
- Returns
- An iterator pointing to the beginning of the search results list.
override HPS.Type HPS.SearchResults.ObjectType |
( |
| ) |
|
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
override void HPS.SearchResults.Reset |
( |
| ) |
|
|
inlinevirtual |
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.SearchResults.cs