chatEnumChannelBansCallback

GameSpy SDK

chatEnumChannelBansCallback

Called after an attempt to enumerate channel bans.

typedef void (*chatEnumChannelBansCallback)(
CHAT chat,
CHATBool success,
const gsi_char * channel,
int numBans,
const gsi_char ** bans,
void * param );
RoutineRequired HeaderDistribution
chatEnumChannelBansCallback<chat.h>SDKZIP

Parameters

chat
[in] The initialized chat interface object.
success
[in] CHATTrue if success, CHATFalse if failure.
channel
[in] The channel that the enumeration was attempted
numBans
[in] The number of bans in the list
bans
[in] The List of bans
param
[in] Pointer to user data. Passed through unmodified from the initiating function.

Remarks

The chatEnumChannelBansCallback function is called when an attempt to enumerate channel bans has completed. The available results are whether the attempt was successful, the list of the bans, number of bans, the channel that the attempt was made on.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
chatEnumChannelBansCallbackchatEnumChannelBansCallbackAchatEnumChannelBansCallbackW

chatEnumChannelBansCallbackW and chatEnumChannelBansCallbackA are UNICODE and ANSI mapped versions of chatEnumChannelBansCallback. The arguments of chatEnumChannelBansCallbackA are ANSI strings; those of chatEnumChannelBansCallbackW are wide-character strings.

Section Reference: Gamespy Chat SDK