chatEnumUsers
Retrieves the list of users in the specified channel.
- void chatEnumUsers(
- CHAT chat,
- const gsi_char * channel,
- chatEnumUsersCallback callback,
- void * param,
- CHATBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| chatEnumUsers | <chat.h> | SDKZIP |
Parameters
- chat
- [in] Chat SDK object, previously initialized using one of the chatConnect methods.
- channel
- [in] Name of the chat channel whose user list is being retrieved.
- callback
- [in] Optional user-supplied function to be called when the operation has completed; will be passed the user 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.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatEnumUsers | chatEnumUsersA | chatEnumUsersW |
chatEnumUsersW and chatEnumUsersA are UNICODE and ANSI mapped versions of chatEnumUsers. The arguments of chatEnumUsersA are ANSI strings; those of chatEnumUsersW are wide-character strings.
Section Reference: Gamespy Chat SDK