Joins a chat channel.

void chatEnterChannel(

CHAT chat,

const gsi_char * channel,

const gsi_char * password,

chatChannelCallbacks * callbacks,

chatEnterChannelCallback callback,

void * param,

CHATBool blocking );

Parameters

chat

[in] Chat SDK object, previously initialized using one of the chatConnect methods.

channel

[in] Name of the chat channel being joined.

password

[in] Password of the channel.  Ignored if no password has been set.

callbacks

[in] Structure for specifying global handlers; for channel-specific traffic such as user messages.

callback

[in] Optional user-supplied function to be called when the operation has completed.

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 chatEnterChannel function is used to add the local client to a chat channel.  If the channel is password protected the valid password must be supplied.  If it is not, the callback will be triggered with an invalid password result.

Unicode Mappings

chatEnterChannelW and chatEnterChannelA are UNICODE and ANSI mapped versions of chatEnterChannel. The arguments of chatEnterChannelA are ANSI strings; those of chatEnterChannelW are wide-character strings.

Section Reference: Gamespy Chat SDK

See Also: ChatConnect, ChatDisconnect