chatLeaveChannel
Leave a chat channel.
- void chatLeaveChannel(
- CHAT chat,
- const gsi_char * channel,
- const gsi_char * reason );
| Routine | Required Header | Distribution |
|---|---|---|
| chatLeaveChannel | <chat.h> | SDKZIP |
Parameters
- chat
- [in] Chat SDK object, previously initialized using one of the chatConnect methods.
- channel
- [in] Name of the chat channel being left.
- reason
- [in] Optional reason for leaving. This may be displayed to the remaining users.
Remarks
The chatLeaveChannel function is used to remove the local client from a chat channel.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatLeaveChannel | chatLeaveChannelA | chatLeaveChannelW |
chatLeaveChannelW and chatLeaveChannelA are UNICODE and ANSI mapped versions of chatLeaveChannel. The arguments of chatLeaveChannelA are ANSI strings; those of chatLeaveChannelW are wide-character strings.
Section Reference: Gamespy Chat SDK
See Also: ChatConnect, ChatDisconnect