Enumerates the chat channels on the server.

void chatEnumChannels(

CHAT chat,

const gsi_char * filter,

chatEnumChannelsCallbackEach callbackEach,

chatEnumChannelsCallbackAll callbackAll,

void * param,

CHATBool blocking );

Parameters

chat

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

filter

[in] String comparision used to filter the channel results.  Example "#gsp!mygame!". Use the "*" for the wildcard.

callbackEach

[in] Optional user-supplied function to be called once for each channel in the list.

callbackAll

[in] Optional user-supplied function to be called once for the full channel list.

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 chatEnumChannels function enumerates the chat channels which match the currect search criteria. Typical information returned on each channel includes the topic and number of users. The filter can contain wildcards used to get all channels when passing in a partial name and wildcard.

Unicode Mappings

chatEnumChannelsW and chatEnumChannelsA are UNICODE and ANSI mapped versions of chatEnumChannels. The arguments of chatEnumChannelsA are ANSI strings; those of chatEnumChannelsW are wide-character strings.

Section Reference: Gamespy Chat SDK

See Also: ChatConnect, ChatDisconnect