chatEnumChannelBans
Retrieves a list of clients banned from a channel.
- void chatEnumChannelBans(
- CHAT chat,
- const gsi_char * channel,
- chatEnumChannelBansCallback callback,
- void * param,
- CHATBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| chatEnumChannelBans | <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 ban list is being retrieved.
- callback
- [in] Optional user-supplied function to be called when the operation has completed; will be passed the list of banned clients.
- 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 local client must have operator privileges to execute this command.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatEnumChannelBans | chatEnumChannelBansA | chatEnumChannelBansW |
chatEnumChannelBansW and chatEnumChannelBansA are UNICODE and ANSI mapped versions of chatEnumChannelBans. The arguments of chatEnumChannelBansA are ANSI strings; those of chatEnumChannelBansW are wide-character strings.
Section Reference: Gamespy Chat SDK