peerListGroupRoomsCallback

GameSpy SDK

peerListGroupRoomsCallback

Callback for peerListGroupRooms.

typedef void (*peerListGroupRoomsCallback)(
PEER peer,
PEERBool success,
int groupID,
SBServer server,
const gsi_char * name,
int numWaiting,
int maxWaiting,
int numGames,
int numPlaying,
void * param );
RoutineRequired HeaderDistribution
peerListGroupRoomsCallback<peer.h>SDKZIP

Parameters

peer
[in] Initialized peer object
success
[in] PEERTrue if successful, PEERFalse if failure
groupID
[in] The group ID of the current group room
server
[in] A valid SBServer object associated with this group room
name
[in] The name of the group room
numWaiting
[in] The number number of players in the room
maxWaiting
[in] The maximum number of players allowed in the room
numGames
[in] The number of games in the room
numPlaying
[in] The number of players already in a game for the room
param
[in] Pointer to user data. This is optional and will be passed unmodified to the callback function.

Remarks

The peerListGroupRoomsCallback function gets called once for each group room when listing group rooms. After this has been called for each group room, it will be called one more time with "groupID" set to 0.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerListGroupRoomsCallbackpeerListGroupRoomsCallbackApeerListGroupRoomsCallbackW

peerListGroupRoomsCallbackW and peerListGroupRoomsCallbackA are UNICODE and ANSI mapped versions of peerListGroupRoomsCallback. The arguments of peerListGroupRoomsCallbackA are ANSI strings; those of peerListGroupRoomsCallbackW are wide-character strings.

Section Reference: Gamespy Peer SDK