chatSetUserMode

GameSpy SDK

chatSetUserMode

Set the IRC mode of the specified user.  This mode is applied in the specified channel.

void chatSetUserMode(
CHAT chat,
const gsi_char * channel,
const gsi_char * user,
int mode );
RoutineRequired HeaderDistribution
chatSetUserMode<chat.h>SDKZIP

Parameters

chat
[in] Chat SDK object, previously initialized using one of the chatConnect methods.
channel
[in] Name of the user's chat channel.
user
[in] User's chat nickname on that channel.
mode
[in] User mode flags.  See Remarks.

Remarks

The chatSetUserMode function may be used to set a user's mode in a particular channel. Modes are used to track which users have operator and speaking privileges.

The following user mode flags are defined:
CHAT_NORMAL -- Normal (no speaking privileges; no operator privileges)
CHAT_VOICE -- User has speaking privileges.
CHAT_OP -- User has operator privileges.

User mode flags may be OR'ed together. CHAT_NORMAL is superseded by any other user mode flag.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatSetUserModechatSetUserModeAchatSetUserModeW

chatSetUserModeW and chatSetUserModeA are UNICODE and ANSI mapped versions of chatSetUserMode. The arguments of chatSetUserModeA are ANSI strings; those of chatSetUserModeW are wide-character strings.

Section Reference: Gamespy Chat SDK