peerSetPassword
Set the password on the chat room. Local client must be the host.
- void peerSetPassword(
- PEER peer,
- RoomType roomType,
- const gsi_char password[PEER_PASSWORD_LEN] );
Routine | Required Header | Distribution |
---|---|---|
peerSetPassword | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom.
- password
- [in] Password to set on this room.
Remarks
The peerSetPassword sets a password in a room a local player hosting. The only RoomType currently supported is StagingRoom. This will only work if the player is hosting the room. If password is NULL or "", the password will be cleared.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
peerSetPassword | peerSetPasswordA | peerSetPasswordW |
peerSetPasswordW and peerSetPasswordA are UNICODE and ANSI mapped versions of peerSetPassword. The arguments of peerSetPasswordA are ANSI strings; those of peerSetPasswordW are wide-character strings.
Section Reference: Gamespy Peer SDK