peerSetTitle

GameSpy SDK

peerSetTitle

Set the game information to be used by the peer sdk.

PEERBool peerSetTitle(
PEER peer,
const gsi_char * title,
const gsi_char * qrSecretKey,
const gsi_char * sbName,
const gsi_char * sbSecretKey,
int sbGameVersion,
int sbMaxUpdates,
PEERBool natNegotiate,
PEERBool pingRooms[NumRooms],
PEERBool crossPingRooms[NumRooms] );
RoutineRequired HeaderDistribution
peerSetTitle<peer.h>SDKZIP

Return Value

This function returns PEERFalse if an error occurs, otherwise PEERTrue.

Parameters

peer
[in] Initialized peer object.
title
[in] Your gamename, assigned by GameSpy.
qrSecretKey
[in] Secret key for title, assigned by GameSpy.
sbName
[in] Servers returned will be for this GameName.  (Usually the same as title.)
sbSecretKey
[in] Secret key for sbName.
sbGameVersion
[in] Game version for the local client.
sbMaxUpdates
[in] The maximum number of server queries the SDK will send out at one time.
natNegotiate
[in] Set to PEERTrue if nat negotiation is supported.
pingRooms
[in] Array of PEERBool, use to indicate which room types to automatically ping.
crossPingRooms
[in] Array of PEERBool, use to indicate which room types to automatically cross ping.

Remarks

The peerSetTitle function sets title information for the peer sdk such as that used in server browing and reporting. This should be called after peerInitialize and before any of the connection functions: peerConnect, peerConnectLogin, peerConnectPreAuth.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerSetTitlepeerSetTitleApeerSetTitleW

peerSetTitleW and peerSetTitleA are UNICODE and ANSI mapped versions of peerSetTitle. The arguments of peerSetTitleA are ANSI strings; those of peerSetTitleW are wide-character strings.

Section Reference: Gamespy Peer SDK