chatGetUserMode

GameSpy SDK

chatGetUserMode

Get the mode of a user in a specified channel.

void chatGetUserMode(
CHAT chat,
const gsi_char * channel,
const gsi_char * user,
chatGetUserModeCallback callback,
void * param,
CHATBool blocking );
RoutineRequired HeaderDistribution
chatGetUserMode<chat.h>SDKZIP

Parameters

chat
[in] Chat SDK object, previously initialized using one of the chatConnect methods.
channel
[in] Name of the chat channel being inspected.
user
[in] User's chat nickname on that channel.
callback
[in] Optional user-supplied function to be called when the operation has completed; will be passed user's mode.
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 chatGetUserMode function may be used to check a user's "mode" in a specified chat channel.  A mode may specify a channel operator.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetUserModechatGetUserModeAchatGetUserModeW

chatGetUserModeW and chatGetUserModeA are UNICODE and ANSI mapped versions of chatGetUserMode. The arguments of chatGetUserModeA are ANSI strings; those of chatGetUserModeW are wide-character strings.

Section Reference: Gamespy Chat SDK

See Also: chatGetUserModeNoWait