peerLeaveRoom
Remove the local client from a room.
- void peerLeaveRoom(
- PEER peer,
- RoomType roomType,
- const gsi_char * reason );
| Routine | Required Header | Distribution |
|---|---|---|
| peerLeaveRoom | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom.
- reason
- [in] Optional text reason broadcast to the room.
Remarks
The peerLeaveRoom function will take the local player out of the current room. Any room can be left without affecting any other room.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerLeaveRoom | peerLeaveRoomA | peerLeaveRoomW |
peerLeaveRoomW and peerLeaveRoomA are UNICODE and ANSI mapped versions of peerLeaveRoom. The arguments of peerLeaveRoomA are ANSI strings; those of peerLeaveRoomW are wide-character strings.
Section Reference: Gamespy Peer SDK