peerJoinGroupRoom
Join the specified group room.
- void peerJoinGroupRoom(
- PEER peer,
- int groupID,
- peerJoinRoomCallback callback,
- void * param,
- PEERBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| peerJoinGroupRoom | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- groupID
- [in] ID number of the group. See remarks.
- 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 peerJoinGroupRoom function may be used to join the GroupRoom which matches the specified groupID. Group IDs may be obtained through the peerListGroupRooms call. The peer object must be connected to the chat server and have a title set before joining any rooms.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerJoinGroupRoom | peerJoinGroupRoomA | peerJoinGroupRoomW |
peerJoinGroupRoomW and peerJoinGroupRoomA are UNICODE and ANSI mapped versions of peerJoinGroupRoom. The arguments of peerJoinGroupRoomA are ANSI strings; those of peerJoinGroupRoomW are wide-character strings.
Section Reference: Gamespy Peer SDK