peerJoinTitleRoom
Join the title room for the local client’s game application.
- void peerJoinTitleRoom(
- PEER peer,
- const gsi_char password[PEER_PASSWORD_LEN],
- peerJoinRoomCallback callback,
- void * param,
- PEERBool blocking );
| Routine | Required Header | Distribution |
|---|---|---|
| peerJoinTitleRoom | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- password
- [in] Optional password of the title room. Usually NULL.
- 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 peerJoinTitleRoom function Joins the title room of the currently selected game title. This is typically called right after connecting, and it is only valid if a title is set. If the user is already in a title room, this function will fail.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerJoinTitleRoom | peerJoinTitleRoomA | peerJoinTitleRoomW |
peerJoinTitleRoomW and peerJoinTitleRoomA are UNICODE and ANSI mapped versions of peerJoinTitleRoom. The arguments of peerJoinTitleRoomA are ANSI strings; those of peerJoinTitleRoomW are wide-character strings.
Section Reference: Gamespy Peer SDK