chatGetChannelBasicUserInfoCallback

GameSpy SDK

chatGetChannelBasicUserInfoCallback

Called when an attempt to get everyone's basic user info is made.

typedef void (*chatGetChannelBasicUserInfoCallback)(
CHAT chat,
CHATBool success,
const gsi_char * channel,
const gsi_char * nick,
const gsi_char * user,
const gsi_char * address,
void * param );
RoutineRequired HeaderDistribution
chatGetChannelBasicUserInfoCallback<chat.h>SDKZIP

Parameters

chat
[in] The initialized chat interface object.
success
[in] CHATTrue if success, CHATFalse if failure.
channel
[in] The name of the channel
nick
[in] The local player's chat nickname
user
[in] The nickname of the target user
address
[in] The IP address of the target user
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatGetChannelBasicUserInfoCallback function is called with a user's basic info for everyone in a channel. Called with a NULL nick/user/address at the end.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetChannelBasicUserInfoCallbackchatGetChannelBasicUserInfoCallbackAchatGetChannelBasicUserInfoCallbackW

chatGetChannelBasicUserInfoCallbackW and chatGetChannelBasicUserInfoCallbackA are UNICODE and ANSI mapped versions of chatGetChannelBasicUserInfoCallback. The arguments of chatGetChannelBasicUserInfoCallbackA are ANSI strings; those of chatGetChannelBasicUserInfoCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK