chatSetChannelPassword
Sets or clears a password on the specified channel.
- void chatSetChannelPassword(
- CHAT chat,
- const gsi_char * channel,
- CHATBool enable,
- const gsi_char * password );
| Routine | Required Header | Distribution |
|---|---|---|
| chatSetChannelPassword | <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 password is being set.
- enable
- [in] If CHATTrue, enable the password; otherwise, disable.
- password
- [in] Password string which users must supply to join the channel.
Remarks
Set the value to NULL or "" to clear the value.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| chatSetChannelPassword | chatSetChannelPasswordA | chatSetChannelPasswordW |
chatSetChannelPasswordW and chatSetChannelPasswordA are UNICODE and ANSI mapped versions of chatSetChannelPassword. The arguments of chatSetChannelPasswordA are ANSI strings; those of chatSetChannelPasswordW are wide-character strings.
Section Reference: Gamespy Chat SDK