peerEnumPlayersCallback
Called for peerEnumPlayers for each player.
- typedef void (*peerEnumPlayersCallback)(
- PEER peer,
- PEERBool success,
- RoomType roomType,
- int index,
- const gsi_char * nick,
- int flags,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| peerEnumPlayersCallback | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object
- success
- [in] PEERTrue if successful, or PEERFalse if failure
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom
- index
- [in] The index of the current player being enumerated
- nick
- [in] The Chat nickname of that player
- flags
- [in] The Flags of that player
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
Remarks
Called for each player in a room being enumerated, and once when finished, with "index" set to -1 and "nick" set to NULL. The index is not an identifier of any sort, its just a way to count the number of players that have been enumerated. It is not persistant in any way.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerEnumPlayersCallback | peerEnumPlayersCallbackA | peerEnumPlayersCallbackW |
peerEnumPlayersCallbackW and peerEnumPlayersCallbackA are UNICODE and ANSI mapped versions of peerEnumPlayersCallback. The arguments of peerEnumPlayersCallbackA are ANSI strings; those of peerEnumPlayersCallbackW are wide-character strings.
Section Reference: Gamespy Peer SDK