chatEnterChannelCallback

GameSpy SDK

chatEnterChannelCallback

Called when an attempt to enter the channel has completed.

typedef void (*chatEnterChannelCallback)(
CHAT chat,
CHATBool success,
CHATEnterResult result,
const gsi_char * channel,
void * param );
RoutineRequired HeaderDistribution
chatEnterChannelCallback<chat.h>SDKZIP

Parameters

chat
[in] The initialized chat interface object.
success
[in] CHATTrue if success, CHATFalse if failure.
result
[in] Indicates the result of the attempt
channel
[in] The name of channel entered
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatEnterChannelCallback funtion is called when the attempt to enter the channel by the local player is completed. The entrance of the channel can be successful or a failure, and is indicated by the "result" of the attempt. The "result" can be of the following value:
CHATEnterSuccess -- The channel was successfully entered.
CHATBadChannelName -- The channel name was invalid.
CHATChannelIsFull -- The channel is at its user limit.
CHATInviteOnlyChannel -- The channel is invite only.
CHATBannedFromChannel -- The local user is banned from this channel.
CHATBadChannelPassword -- The channel has a password, and a bad password (or none) was given.
CHATTooManyChannels -- The server won't allow this user in any more channels.
CHATEnterTimedOut -- The attempt to enter timed out.
CHATBadChannelMask -- The channel mask was bad (rarely used).

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatEnterChannelCallbackchatEnterChannelCallbackAchatEnterChannelCallbackW

chatEnterChannelCallbackW and chatEnterChannelCallbackA are UNICODE and ANSI mapped versions of chatEnterChannelCallback. The arguments of chatEnterChannelCallbackA are ANSI strings; those of chatEnterChannelCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK