chatKickUser
Forcefully remove a user from a specified channel. .
- void chatKickUser(
- CHAT chat,
- const gsi_char * channel,
- const gsi_char * user,
- const gsi_char * reason );
| Routine | Required Header | Distribution |
|---|---|---|
| chatKickUser | <chat.h> | SDKZIP |
Parameters
- chat
- [in] Chat SDK object, previously initialized using one of the chatConnect methods.
- channel
- [in] Name of the chat channel from which the user is being removed.
- user
- [in] User's chat nickname.
- reason
- [in] Optional text string that will be sent along with the kick message. This message will appear in the user kick callback.
Remarks
The local client must have operator privileges to execute this command.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatKickUser | chatKickUserA | chatKickUserW |
chatKickUserW and chatKickUserA are UNICODE and ANSI mapped versions of chatKickUser. The arguments of chatKickUserA are ANSI strings; those of chatKickUserW are wide-character strings.
Section Reference: Gamespy Chat SDK