chatGetGlobalKeysCallback

GameSpy SDK

chatGetGlobalKeysCallback

Called after an attempt to get the global keys for the user(s).

typedef void (*chatGetGlobalKeysCallback)(
CHAT chat,
CHATBool success,
const gsi_char * user,
int num,
const gsi_char ** keys,
const gsi_char ** values,
void * param );
RoutineRequired HeaderDistribution
chatGetGlobalKeysCallback<chat.h>SDKZIP

Parameters

chat
[in] The initialized chat interface object.
success
[in] CHATTrue if success, CHATFalse if failure.
user
[in] The nickname of the target user or the name of the channel
num
[in] The number of key/value pairs in the array
keys
[in] The array of key names whose values will be retrieved
values
[in] The array of values associated with the key array
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatGetGlobalKeysCallback function is called when an attempt to obtain the global keys of a user or all users is complete. If successful, the keys for those user(s) will be available.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetGlobalKeysCallbackchatGetGlobalKeysCallbackAchatGetGlobalKeysCallbackW

chatGetGlobalKeysCallbackW and chatGetGlobalKeysCallbackA are UNICODE and ANSI mapped versions of chatGetGlobalKeysCallback. The arguments of chatGetGlobalKeysCallbackA are ANSI strings; those of chatGetGlobalKeysCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK