chatGetUserModeCallback

GameSpy SDK

chatGetUserModeCallback

Called after an attempt to get the user's mode.

typedef void (*chatGetUserModeCallback)(
CHAT chat,
CHATBool success,
const gsi_char * channel,
const gsi_char * user,
int mode,
void * param );
RoutineRequired HeaderDistribution
chatGetUserModeCallback<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
user
[in] The nickname of the target user
mode
[in] One of the predefined modes
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatGetUserModeCallback function is called when an attempt to get the user mode is completed. If successful, the user's nickname and mode will be available.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetUserModeCallbackchatGetUserModeCallbackAchatGetUserModeCallbackW

chatGetUserModeCallbackW and chatGetUserModeCallbackA are UNICODE and ANSI mapped versions of chatGetUserModeCallback. The arguments of chatGetUserModeCallbackA are ANSI strings; those of chatGetUserModeCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK