peerListGroupRooms
List all the group rooms for the currently set title.
- void peerListGroupRooms(
- PEER peer,
- const gsi_char * fields,
- peerListGroupRoomsCallback callback,
- void * param,
- PEERBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| peerListGroupRooms | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- fields
- [in] Backslash delimited list of fields.
- callback
- [in] Callback function to be called when the operation completes.
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
- blocking
- [in] When set to PEERTrue this function will not return until the operation has completed.
Remarks
The peerListGroupRooms functions lists all the groups rooms for the currently set title. The callback will be called once for each title, then it will be called once again with a "groupID" of 0. The groupIDs can be used with peerJoinGroupRoom() to join a group. This function will fail if no title is set.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerListGroupRooms | peerListGroupRoomsA | peerListGroupRoomsW |
peerListGroupRoomsW and peerListGroupRoomsA are UNICODE and ANSI mapped versions of peerListGroupRooms. The arguments of peerListGroupRoomsA are ANSI strings; those of peerListGroupRoomsW are wide-character strings.
Section Reference: Gamespy Peer SDK