chatGetChannelPasswordCallback

GameSpy SDK

chatGetChannelPasswordCallback

Called after an attempt to get the channel's password.

typedef void (*chatGetChannelPasswordCallback)(
CHAT chat,
CHATBool success,
const gsi_char * channel,
CHATBool enabled,
const gsi_char * password,
void * param );
RoutineRequired HeaderDistribution
chatGetChannelPasswordCallback<chat.h>SDKZIP

Parameters

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

Remarks

The chatGetChannelPasswordCallback function is called when an attempt to obtain the channel's password is complete. If successful, the password for that channel will be available.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetChannelPasswordCallbackchatGetChannelPasswordCallbackAchatGetChannelPasswordCallbackW

chatGetChannelPasswordCallbackW and chatGetChannelPasswordCallbackA are UNICODE and ANSI mapped versions of chatGetChannelPasswordCallback. The arguments of chatGetChannelPasswordCallbackA are ANSI strings; those of chatGetChannelPasswordCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK