DX::IDXGetGroupResult Struct Reference
#include <IDXGetGroupResult.h>
List of all members.
|
Public Member Functions |
virtual uint DXMCALL | GetNumGroups () const =0 |
virtual DXError DXMCALL | GetGroup (uint index, IDXGroupPtr *out) const =0 |
virtual DXError DXMCALL | AddGroup (IDXGroupPtr group)=0 |
Detailed Description
IDXGetGroupResult facilitates the finding of multiple groups. Its lifetime is limited to until the next search is performed or the object is deleted.
Member Function Documentation
virtual DXError DXMCALL DX::IDXGetGroupResult::AddGroup |
( |
IDXGroupPtr |
group |
) |
[pure virtual] |
Add a group to the results.
- Parameters:
-
| group | An IDXGroupPtr to add. |
- Returns:
- Error_NullParam if group was null.
Error_Duplicate if group was already present.
Error_Success if group was added.
virtual DXError DXMCALL DX::IDXGetGroupResult::GetGroup |
( |
uint |
index, |
|
|
IDXGroupPtr * |
out | |
|
) |
| | const [pure virtual] |
Get the group at the specified index.
- Parameters:
-
| index | The index of the group to retrieve. |
| out | A pointer to an IDXGroupPtr where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.
virtual uint DXMCALL DX::IDXGetGroupResult::GetNumGroups |
( |
|
) |
const [pure virtual] |
Get the number of groups that are in the group search result.
- Returns:
- The number of groups.