Simias::Storage::Provider::Flaim::FlaimResultSet Class Reference
Summary description for FlaimObjectIterator. More...
Inheritance diagram for Simias::Storage::Provider::Flaim::FlaimResultSet:
Collaboration diagram for Simias::Storage::Provider::Flaim::FlaimResultSet:
Public Member Functions | |
| FlaimResultSet (IntPtr pResultSet, int count, FlaimServer flaimServer) | |
| int | GetNext (ref char[] buffer) |
| Method to return the next set of objects. All the objects that can fit in the buffer will be returned. returns false when no more objects exist. | |
| bool | SetIndex (IndexOrigin origin, int offset) |
| Set the Index to the specified offset from the origin. | |
| void | Dispose () |
| Method to cleanup any Flaim resources held. | |
Properties | |
| int | Count [get] |
| Property to get the count of available objects. | |
Detailed Description
Summary description for FlaimObjectIterator.
Constructor & Destructor Documentation
| Simias::Storage::Provider::Flaim::FlaimResultSet::FlaimResultSet | ( | IntPtr | pResultSet, | |
| int | count, | |||
| FlaimServer | flaimServer | |||
| ) | [inline] |
- Parameters:
-
pResultSet count
Member Function Documentation
| int Simias::Storage::Provider::Flaim::FlaimResultSet::GetNext | ( | ref char[] | buffer | ) | [inline] |
Method to return the next set of objects. All the objects that can fit in the buffer will be returned. returns false when no more objects exist.
- Parameters:
-
buffer Buffer used to return the objects.
- Returns:
- true - objects returned. false - no more objects
Implements Simias::Storage::Provider::IResultSet.
| bool Simias::Storage::Provider::Flaim::FlaimResultSet::SetIndex | ( | IndexOrigin | origin, | |
| int | offset | |||
| ) | [inline] |
Set the Index to the specified offset from the origin.
- Parameters:
-
origin The origin to move from offset The offset to move the index by.
- Returns:
- True if successful.
Implements Simias::Storage::Provider::IResultSet.
| void Simias::Storage::Provider::Flaim::FlaimResultSet::Dispose | ( | ) | [inline] |
Method to cleanup any Flaim resources held.
Property Documentation
int Simias::Storage::Provider::Flaim::FlaimResultSet::Count [get] |
The documentation for this class was generated from the following file:
- src/core/FlaimProvider/FlaimResultSet.cs
