chatGetChannelKeysCallback

GameSpy SDK

chatGetChannelKeysCallback

Called after an attempt to get the channel keys or user(s) keys.

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

Parameters

chat
[in] The initialized chat interface object.
success
[in] CHATTrue if success, CHATFalse if failure.
channel
[in] The name of the channel
user
[in] The nickname of the target user
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 array of keys
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatGetChannelKeysCallback function is called when an attempt to either get either the channel or user(s) keys is completed. If the call to chatGetChannelKeys was made on a set of users, then this function will get called for all users and have a NULL for "user" when done. If the call was for the channel keys, then the "user" will be NULL.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetChannelKeysCallbackchatGetChannelKeysCallbackAchatGetChannelKeysCallbackW

chatGetChannelKeysCallbackW and chatGetChannelKeysCallbackA are UNICODE and ANSI mapped versions of chatGetChannelKeysCallback. The arguments of chatGetChannelKeysCallbackA are ANSI strings; those of chatGetChannelKeysCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK