Retrieves a list of key/value pairs for a channel or user.

void chatGetChannelKeys(

CHAT chat,

const gsi_char * channel,

const gsi_char * user,

int num,

const gsi_char ** keys,

chatGetChannelKeysCallback callback,

void * param,

CHATBool blocking );

Parameters

chat

[in] Chat SDK object, previously initialized using one of the chatConnect methods.

channel

[in] Name of the chat channel from which key/value pairs are being retrieved

user

[in] Name of the user whose key/value pairs are being retrieved, or "*" to indicate the channel itself.

num

[in] Number of keys in the keys array.

keys

[in] Array of keys for which values will be returned.

callback

[in] Optional user-supplied function to be called when the operation has completed.

param

[in] Optional pointer to user data; will be passed unmodified to the callback function.

blocking

[in] If CHATTrue, return only after the operation has completed; otherwise, return immediately.

Remarks

The chatGetChannelKeys function retrieves a list of key/value pairs for the specified channel or user. If the user parameter is set to a user nickname, key/value pairs will be returned only for the specified user. If the user parameter is set to "*", values on the channel itself will be returned.

Unicode Mappings

chatGetChannelKeysW and chatGetChannelKeysA are UNICODE and ANSI mapped versions of chatGetChannelKeys. The arguments of chatGetChannelKeysA are ANSI strings; those of chatGetChannelKeysW are wide-character strings.

Section Reference: Gamespy Chat SDK