peerSetRoomKeys

GameSpy SDK

peerSetRoomKeys

Set room keys for a player or the room itself.

void peerSetRoomKeys(
PEER peer,
RoomType roomType,
const gsi_char * nick,
int num,
const gsi_char ** keys,
const gsi_char ** values );
RoutineRequired HeaderDistribution
peerSetRoomKeys<peer.h>SDKZIP

Parameters

peer
[in] Initialized peer object.
roomType
[in] Can be either TitleRoom, GroupRoom or StagingRoom.
nick
[in] Nickname of the target player.
num
[in] Number of keys to set.
keys
[in] Array of keys to set values for.
values
[in] Array of values to set.

Remarks

The peerSetRoomKeys function is used to set a player’s room keys or to set a room’s keys. Only hosts can set keys on the room, and only hosts can set keys on other players. This will fail if no title is set and the peer is not connected.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerSetRoomKeyspeerSetRoomKeysApeerSetRoomKeysW

peerSetRoomKeysW and peerSetRoomKeysA are UNICODE and ANSI mapped versions of peerSetRoomKeys. The arguments of peerSetRoomKeysA are ANSI strings; those of peerSetRoomKeysW are wide-character strings.

Section Reference: Gamespy Peer SDK