Join a staging room using the channel name.

void peerJoinStagingRoomByChannel(

PEER peer,

const gsi_char * channel,

const gsi_char password[PEER_PASSWORD_LEN],

peerJoinRoomCallback callback,

void * param,

PEERBool blocking );

Parameters

peer

[in] Initialized peer object.

channel

[in] Chat channel name.

password

[in] Optional password of the room.

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 peerJoinStagingRoomByChannel connects the local player to a staging room by using it's channel name. A "password" will be checked to match the password passed to peerCreateStaginRoom. Spaces in passwords are not allowed. Any password with spaces should be stripped of those spaces before calling this function, or a warning to the user will suffice.This call will only work if the server was listed with "staging" set to true. Otherwise the game has already been launched and should be joined directly. The function will fail if the channel does not have "staging" set to true.

Unicode Mappings

peerJoinStagingRoomByChannelW and peerJoinStagingRoomByChannelA are UNICODE and ANSI mapped versions of peerJoinStagingRoomByChannel. The arguments of peerJoinStagingRoomByChannelA are ANSI strings; those of peerJoinStagingRoomByChannelW are wide-character strings.

Section Reference: Gamespy Peer SDK