Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The EnumGroupsInGroup method will enumerate groups and group links contained within the specified group.
Only the contents of the specified group will be enumerated, not the groups it contains.
Remote sessions that are not password protected can have their groups enumerated by using the DPENUMGROUPS_SESSION flag and specifying the GUID of the remote session when there is no session open.
To enumerate groups in a lobby session, you must be connected to it.
The TDx_Play::OnEnumGroupsInGroup() event will be called for each group enumerated.
Error values that can be generated are:
DPERR_CONNECTIONLOST
DPERR_INVALIDFLAGS
DPERR_INVALIDGROUP
DPERR_INVALIDPARAMS
DPERR_NOSESSIONS
DPERR_UNSUPPORTED
- Parameters
Group
The Group parameter identifies the group whose subgroups are to be enumerated.
Instance
The Instance parameter references the identifier of the session whose group is to be enumerated.
The DPENUMGROUPS_SESSION flag must be set to use this parameter.
Session GUIDs are obtained by TDx_Play::EnumSessions().
Context
The Context parameter references application defined data to be passed to the callback function for each group enumerated.
Flags
The Flags parameter defines flags indicating how to perform the enumeration.
The described effect applies when the flag is set.
The default setting of zero results in the enumeration of all groups in the specified group.
Only groups meeting all of the specified criteria will be enumerated.
-
DPENUMGROUPS_ALL
Enumerate all groups within the specified group.
DPENUMGROUPS_HIDDEN
Only enumerate hidden groups within the specified group.
DPENUMGROUPS_LOCAL
Only enumerate locally created groups within the specified group.
DPENUMGROUPS_REMOTE
Only enumerate remotely created groups within the specified group.
DPENUMGROUPS_SESSION
Enumerate the specified group in the session identified by the Instance parameter.
Only usable when there is no session open and the target session is not a lobby session.
DPENUMGROUPS_SHORTCUT
Only enumerate only the linked groups within the specified group.
DPENUMGROUPS_STAGINGAREA
Only enumerate staging area groups within the specified group.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::EnumGroupsInGroup() ] [ next: EnumPlayers() ] [ prev: EnumGroups() ] public:
virtual bool __fastcall EnumGroupsInGroup( DPID pGroup, GUID* pInstance, void* pContext, dword pFlags );
TDX_PLAY::ENUMGROUPSINGROUP()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|