Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The EnumGroups method will enumerate the top level groups of the session.
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::OnEnumGroups() event will be called for each group enumerated.
Error values that can be generated are:
DPERR_ACCESSDENIED
DPERR_CONNECTIONLOST
DPERR_INVALIDPARAMS
DPERR_INVALIDGROUP
DPERR_NOSESSIONS
DPERR_UNAVAILABLE
- Parameters
Instance
The Instance parameter references the identifier of the session whose groups are to be enumerated.
Setting NULL will result in the current sessions groups being enumerated.
There must not be an open session and 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 current active session.
Only groups meeting all of the specified criteria will be enumerated.
-
DPENUMGROUPS_ALL
Enumerate all the groups in the session.
DPENUMGROUPS_HIDDEN
Only enumerate available hidden groups.
DPENUMGROUPS_LOCAL
Only enumerate locally created groups.
DPENUMGROUPS_REMOTE
Only enumerate remotely created groups.
DPENUMGROUPS_SESSION
Enumerate the groups of 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_STAGINGAREA
Only enumerate staging area groups.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::EnumGroups() ] [ next: EnumGroupsInGroup() ] [ prev: EnumGroupPlayers() ] public:
virtual bool __fastcall EnumGroups( GUID* pInstance, void* pContext, dword pFlags );
TDX_PLAY::ENUMGROUPS()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|