peerGetRoomKeysCallback
Callback for peerGetRoomKeys.
- typedef void (*peerGetRoomKeysCallback)(
- PEER peer,
- PEERBool success,
- RoomType roomType,
- const gsi_char * nick,
- int num,
- gsi_char ** keys,
- gsi_char ** values,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| peerGetRoomKeysCallback | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object
- success
- [in] PEERTrue if successful, PEERFalse if failure
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom
- nick
- [in] The player's nickname
- num
- [in] The Number of key/value pairs in the array
- keys
- [in] Array of key names whose values will be retrieved
- values
- [in] Array of values to set
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
Remarks
The peerGetRoomKeysCallback function is called when peer wants to obtain the room keys for a specified room. If nick is NULL, these are keys for the room. Otherwise, they are keys for a player in the room.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerGetRoomKeysCallback | peerGetRoomKeysCallbackA | peerGetRoomKeysCallbackW |
peerGetRoomKeysCallbackW and peerGetRoomKeysCallbackA are UNICODE and ANSI mapped versions of peerGetRoomKeysCallback. The arguments of peerGetRoomKeysCallbackA are ANSI strings; those of peerGetRoomKeysCallbackW are wide-character strings.
Section Reference: Gamespy Peer SDK
See Also: peerGetRoomKeys