peerKickedCallback

GameSpy SDK

peerKickedCallback

Callback when a local player was kicked from a room.

typedef void (*peerKickedCallback)(
PEER peer,
RoomType roomType,
const gsi_char * nick,
const gsi_char * reason,
void * param );
RoutineRequired HeaderDistribution
peerKickedCallback<peer.h>SDKZIP

Parameters

peer
[in] Initialized peer object
roomType
[in] Can be either TitleRoom, GroupRoom or StagingRoom.
nick
[in] the player's nickname
reason
[in] An optional explanation string that gives a reason for being kicked
param
[in] Pointer to user data. This is optional and will be passed unmodified to the callback function.

Remarks

The peerKickedCallback is used to notify the local player that s/he was kicked. As the player has already been removed from the room, there is no need to call peerLeaveRoom().

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerKickedCallbackpeerKickedCallbackApeerKickedCallbackW

peerKickedCallbackW and peerKickedCallbackA are UNICODE and ANSI mapped versions of peerKickedCallback. The arguments of peerKickedCallbackA are ANSI strings; those of peerKickedCallbackW are wide-character strings.

Section Reference: Gamespy Peer SDK