Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The EnumPlayers method will enumerate players in the session.
Remote sessions that are not password protected can have their players enumerated by using the DPENUMPLAYERS_SESSION flag and specifying the GUID of the remote session when there is no session open, but the enumeration call must occur after TDx_Play::EnumSessions() and before calling TDx_Play::Open() or TDx_Play::Close().
The TDx_Play::OnEnumPlayers() event will be called for each player enumerated.
You cannot use this method in a lobby session or from within TDx_Play::OnEnumSessions().
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 players are to be enumerated.
The DPENUMPLAYERS_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 player 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 players within the current session.
Only players meeting all of the specified criteria will be enumerated.
-
DPENUMPLAYERS_ALL
Enumerate all players within the session.
DPENUMPLAYERS_GROUP
Include groups in the enumeration.
DPENUMPLAYERS_LOCAL
Only enumerate locally created players.
DPENUMPLAYERS_REMOTE
Only enumerate remotely created players.
DPENUMPLAYERS_SERVERPLAYER
Only enumerate the server player.
DPENUMPLAYERS_SESSION
Enumerate the players 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.
DPENUMPLAYERS_SPECTATOR
Only enumerate spectator players.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_Play::EnumPlayers() ] [ next: EnumSessions() ] [ prev: EnumGroupsInGroup() ] public:
virtual bool __fastcall EnumPlayers( GUID* pInstance, void* pContext, dword pFlags );
TDX_PLAY::ENUMPLAYERS()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|