peerRegisterUniqueNick

GameSpy SDK

peerRegisterUniqueNick

Register a unique nick.  Call in response to peerNickErrorCallback.

void peerRegisterUniqueNick(
PEER peer,
int namespaceID,
const gsi_char * uniquenick,
const gsi_char * cdkey );
RoutineRequired HeaderDistribution
peerRegisterUniqueNick<peer.h>SDKZIP

Parameters

peer
[in] Initialized peer object.
namespaceID
[in] Assigned namespace ID for this title.
uniquenick
[in] Unique nickname to register with cdkey.
cdkey
[in] User’s cdkey.  Uniquenick will be attached to this key.

Remarks

The peerRegisterUniqueNick takes and registers a unique nick supplied. If the nickErrorCallback was called with a type of PEER_UNIQUENICK_EXPIRED or PEER_NO_UNIQUENICK, then this function can be called to associate a uniquenick with the profile which is being used to login (passed to peerConnectLogin). If uniquenick is NULL or an empty string, then the connect attempt will be aborted. This function should only be called in response to a peerNickErrorCallback(). The backend makes certain checks on a uniquenick before it is allowed to be registered. For details on what is checked, see the "Unique Nick Checks" section at the bottom of GameSpy Presence SDK overview documentation.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerRegisterUniqueNickpeerRegisterUniqueNickApeerRegisterUniqueNickW

peerRegisterUniqueNickW and peerRegisterUniqueNickA are UNICODE and ANSI mapped versions of peerRegisterUniqueNick. The arguments of peerRegisterUniqueNickA are ANSI strings; those of peerRegisterUniqueNickW are wide-character strings.

Section Reference: Gamespy Peer SDK