chatGetChannelMode

GameSpy SDK

chatGetChannelMode

Retrieves the "mode" of a channel.

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

Parameters

chat
[in] Chat SDK object, previously initialized using one of the chatConnect methods.
channel
[in] Name of the chat channel whose mode is being retrieved.
callback
[in] User-supplied function to receive mode information.
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.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetChannelModechatGetChannelModeAchatGetChannelModeW

chatGetChannelModeW and chatGetChannelModeA are UNICODE and ANSI mapped versions of chatGetChannelMode. The arguments of chatGetChannelModeA are ANSI strings; those of chatGetChannelModeW are wide-character strings.