chatGetChannelBasicUserInfo

GameSpy SDK

chatGetChannelBasicUserInfo

Retrieves basic user info for every member of the specified channel.

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

Parameters

chat
[in] Chat SDK object, previously initialized using one of the chatConnect methods.
channel
[in] Name of the chat channel from which user information is being retrieved
callback
[in] Optional user-supplied function to be called when the operation has completed.
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.

Remarks

The chatGetChannelBasicUserInfo function retreives basic information for each of the users in the specified channel.  The information returned consists of the nickname, profilename and IP address.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatGetChannelBasicUserInfochatGetChannelBasicUserInfoAchatGetChannelBasicUserInfoW

chatGetChannelBasicUserInfoW and chatGetChannelBasicUserInfoA are UNICODE and ANSI mapped versions of chatGetChannelBasicUserInfo. The arguments of chatGetChannelBasicUserInfoA are ANSI strings; those of chatGetChannelBasicUserInfoW are wide-character strings.

Section Reference: Gamespy Chat SDK