peerAuthenticateCDKey

GameSpy SDK

peerAuthenticateCDKey

Allows pre-chat cd key authentication via the chat server.

void peerAuthenticateCDKey(
PEER peer,
const gsi_char * cdkey,
peerAuthenticateCDKeyCallback callback,
void * param,
PEERBool blocking );
RoutineRequired HeaderDistribution
peerAuthenticateCDKey<peer.h>SDKZIP

Parameters

peer
[in] Initialized peer object.
cdkey
[in] The cdkey to validate. Presumably a valid cdkey for the set game title.
callback
[in] Callback function will be called when the operation has completed.
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 peerAuthenticateCDKey function may be used to authenticate a user’s cdkey before they enter the chat room. This should not be a substitute for a cdkey during gameplay. Arcade does not support this call, so users in Arcade will be able to enter chat without this validation. This method is most useful for developers who opt-out of the Arcade compatability requirements or have a separate chat area for in-game clients.

Unicode Mappings

RoutineGSI_UNICODE Not DefinedGSI_UNICODE Defined
peerAuthenticateCDKeypeerAuthenticateCDKeyApeerAuthenticateCDKeyW

peerAuthenticateCDKeyW and peerAuthenticateCDKeyA are UNICODE and ANSI mapped versions of peerAuthenticateCDKey. The arguments of peerAuthenticateCDKeyA are ANSI strings; those of peerAuthenticateCDKeyW are wide-character strings.

Section Reference: Gamespy Peer SDK