chatInChannel

GameSpy SDK

chatInChannel

Determine whether the local client is a member of the specified channel.

CHATBool chatInChannel(
CHAT chat,
const gsi_char * channel );
RoutineRequired HeaderDistribution
chatInChannel<chat.h>SDKZIP

Return Value

This function will return CHATTrue if the local client is a member of the specified channel, CHATFalse otherwise.

Parameters

chat
[in] Chat SDK object, previously initialized using one of the chatConnect methods.
channel
[in] Name of the chat channel being inspected.

Remarks

The chatInChannel function checks the local list of channels to determine whether the local client is a member. No communication with the server is attempted during this call.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatInChannelchatInChannelAchatInChannelW

chatInChannelW and chatInChannelA are UNICODE and ANSI mapped versions of chatInChannel. The arguments of chatInChannelA are ANSI strings; those of chatInChannelW are wide-character strings.

Section Reference: Gamespy Chat SDK