peerGetRoomGlobalKeys

GameSpy SDK

peerGetRoomGlobalKeys

Retrieves global keys for all players in the specified room. (Local client must be a room member.).

void peerGetRoomGlobalKeys(
PEER peer,
RoomType roomType,
int num,
const gsi_char ** keys,
peerGetGlobalKeysCallback callback,
void * param,
PEERBool blocking );
RoutineRequired HeaderDistribution
peerGetRoomGlobalKeys<peer.h>SDKZIP

Parameters

peer
[in] Initialized peer object.
roomType
[in] Can be either TitleRoom, GroupRoom or StagingRoom.
num
[in] Number of keys 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 peerGetRoomGlobalKeys function retreives the global keys for all players in a room we're in. The callback will be called once for each player in the room, then once more with "nick" set to NULL. This will fail if no title is set, and the peer object is not connected.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerGetRoomGlobalKeyspeerGetRoomGlobalKeysApeerGetRoomGlobalKeysW

peerGetRoomGlobalKeysW and peerGetRoomGlobalKeysA are UNICODE and ANSI mapped versions of peerGetRoomGlobalKeys. The arguments of peerGetRoomGlobalKeysA are ANSI strings; those of peerGetRoomGlobalKeysW are wide-character strings.

Section Reference: Gamespy Peer SDK

See Also: peerGetPlayerGlobalKeys