chatEnumUsersCallback
Called after an attempt to enumerate the users in a channel.
- typedef void (*chatEnumUsersCallback)(
- CHAT chat,
- CHATBool success,
- const gsi_char * channel,
- int numUsers,
- const gsi_char ** users,
- int * modes,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| chatEnumUsersCallback | <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
- numUsers
- [in] The number of users in the channel
- users
- [in] The list of users names in the channel
- modes
- [in] The list of modes for the channel
- param
- [in] Pointer to user data. Passed through unmodified from the initiating function.
Remarks
The chatEnumUsersCallback is called when an attempt to enumerate all of the users in a given channel is made. The function will have the information of the users in the channel if success is CHATTrue.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatEnumUsersCallback | chatEnumUsersCallbackA | chatEnumUsersCallbackW |
chatEnumUsersCallbackW and chatEnumUsersCallbackA are UNICODE and ANSI mapped versions of chatEnumUsersCallback. The arguments of chatEnumUsersCallbackA are ANSI strings; those of chatEnumUsersCallbackW are wide-character strings.
Section Reference: Gamespy Chat SDK