chatBanUser
Ban a user from the chat room. The user may not rejoin.
- void chatBanUser(
- CHAT chat,
- const gsi_char * channel,
- const gsi_char * user );
| Routine | Required Header | Distribution |
|---|---|---|
| chatBanUser | <chat.h> | SDKZIP |
Parameters
- chat
- [in] Chat SDK object, previously initialized using one of the chatConnect methods.
- channel
- [in] Name of chat channel from which user is being banned.
- user
- [in] Chat nickname of user being banned.
Remarks
The caller of this function must have operator privileges for the channel in which the ban is to be performed.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatBanUser | chatBanUserA | chatBanUserW |
chatBanUserW and chatBanUserA are UNICODE and ANSI mapped versions of chatBanUser. The arguments of chatBanUserA are ANSI strings; those of chatBanUserW are wide-character strings.
Section Reference: Gamespy Chat SDK
See Also: ChatConnect