peerGetPlayerGlobalKeys

GameSpy SDK

peerGetPlayerGlobalKeys

Query the server for a player’s global key values.

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

Parameters

peer
[in] Initialized peer object.
nick
[in] The chat nickname of the target player.
num
[in] The number of keys in the array.
keys
[in] Array of key names to request 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 peerGetPlayerGlobalKeys function may be used to retrieve global key values for the specified player. The callback will have these keys available if the function is successful. The key list will be the array of strings that are used to obtain the global key values.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerGetPlayerGlobalKeyspeerGetPlayerGlobalKeysApeerGetPlayerGlobalKeysW

peerGetPlayerGlobalKeysW and peerGetPlayerGlobalKeysA are UNICODE and ANSI mapped versions of peerGetPlayerGlobalKeys. The arguments of peerGetPlayerGlobalKeysA are ANSI strings; those of peerGetPlayerGlobalKeysW are wide-character strings.

Section Reference: Gamespy Peer SDK