chatEnumChannelsCallbackAll

GameSpy SDK

chatEnumChannelsCallbackAll

Called when an attempt to enumerate all the channels is complete.

typedef void (*chatEnumChannelsCallbackAll)(
CHAT chat,
CHATBool success,
int numChannels,
const gsi_char ** channels,
const gsi_char ** topics,
int * numUsers,
void * param );
RoutineRequired HeaderDistribution
chatEnumChannelsCallbackAll<chat.h>SDKZIP

Parameters

chat
[in] The initialized chat interface object.
success
[in] CHATTrue if success, CHATFalse if failure.
numChannels
[in] The number of channels in the list
channels
[in] The List of channels
topics
[in] The List of topics associated with the list of channels
numUsers
[in] The number of users for each channel
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatEnumChannelsCallbackAll function is called when an enumeration attempt of all channels has completed. The function will contain all the data necessary to update the list of channels including names of channels, number of people in each channel, and channel topics. It is also called after each is enumerated (chatEnumChannelsCallbackEach).

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatEnumChannelsCallbackAllchatEnumChannelsCallbackAllAchatEnumChannelsCallbackAllW

chatEnumChannelsCallbackAllW and chatEnumChannelsCallbackAllA are UNICODE and ANSI mapped versions of chatEnumChannelsCallbackAll. The arguments of chatEnumChannelsCallbackAllA are ANSI strings; those of chatEnumChannelsCallbackAllW are wide-character strings.

Section Reference: Gamespy Chat SDK