chatEnumChannelsCallbackEach
Called after an attempt to enumerate each channel.
- typedef void (*chatEnumChannelsCallbackEach)(
- CHAT chat,
- CHATBool success,
- int index,
- const gsi_char * channel,
- const gsi_char * topic,
- int numUsers,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| chatEnumChannelsCallbackEach | <chat.h> | SDKZIP |
Parameters
- chat
- [in] The initialized chat interface object.
- success
- [in] CHATTrue if success, CHATFalse if failure.
- index
- [in] The index of this channel
- channel
- [in] The name of the channel
- topic
- [in] A string containing the topic of the channel
- numUsers
- [in] The number of users in this channel
- param
- [in] Pointer to user data. Passed through unmodified from the initiating function.
Remarks
The chatEnumChannelsCallbackEach function is called when an attempt to enumerate each channel on the server is complete. The successful attempt will have a channel with an index, the name of the channel, the topic for that channel, the number of users.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatEnumChannelsCallbackEach | chatEnumChannelsCallbackEachA | chatEnumChannelsCallbackEachW |
chatEnumChannelsCallbackEachW and chatEnumChannelsCallbackEachA are UNICODE and ANSI mapped versions of chatEnumChannelsCallbackEach. The arguments of chatEnumChannelsCallbackEachA are ANSI strings; those of chatEnumChannelsCallbackEachW are wide-character strings.
Section Reference: Gamespy Chat SDK