Retrieves room key values for the room or a single player.

void peerGetRoomKeys(

PEER peer,

RoomType roomType,

const gsi_char * nick,

int num,

const gsi_char ** keys,

peerGetRoomKeysCallback callback,

void * param,

PEERBool blocking );

Parameters

peer

[in] Initialized peer object.

roomType

[in] Can be either TitleRoom, GroupRoom or StagingRoom.

nick

[in] Nickname of the player to retrieve values on.  "*" to retrieve values for the entire room.

num

[in] Number of valid key names in the array parameter - keys.

keys

[in] Array of key names to retrieve values for.

callback

[in] Callback function to be called when the operation completes.

param

[in] Pointer to user data. This is optional and will be passed unmodified to the callback function.

blocking

[in] When set to PEERTrue, this function will not return until the operation has completed.

Remarks

The peerGetRoomKeys function retreives the keys for either a room, a player in a room, or all the players in a room. If getting keys for a room, or for a single player, the callback will be called once. If getting keys for every player in a room, then it will be called once for each player, then one more time with nick set to NULL. This will fail if no title is set, and the peer object is not connected.

Unicode Mappings

peerGetRoomKeysW and peerGetRoomKeysA are UNICODE and ANSI mapped versions of peerGetRoomKeys. The arguments of peerGetRoomKeysA are ANSI strings; those of peerGetRoomKeysW are wide-character strings.

Section Reference: Gamespy Peer SDK