chatGetUserInfoCallback

GameSpy SDK

chatGetUserInfoCallback

Called after an attempt to get user information.

typedef void (*chatGetUserInfoCallback)(
CHAT chat,
CHATBool success,
const gsi_char * nick,
const gsi_char * user,
const gsi_char * name,
const gsi_char * address,
int numChannels,
const gsi_char ** channels,
void * param );
RoutineRequired HeaderDistribution
chatGetUserInfoCallback<chat.h>SDKZIP

Parameters

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

Remarks

The chatGetUserInfoCallback function is called when an attempt to get the user information about another player is completed. If successful, the user's nickname, IP address, the channels s/he is on will be available.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetUserInfoCallbackchatGetUserInfoCallbackAchatGetUserInfoCallbackW

chatGetUserInfoCallbackW and chatGetUserInfoCallbackA are UNICODE and ANSI mapped versions of chatGetUserInfoCallback. The arguments of chatGetUserInfoCallbackA are ANSI strings; those of chatGetUserInfoCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK