This function attempts to register a uniquenick and associate it with the local profile.

GPResult gpRegisterUniqueNick(

GPConnection * connection,

const gsi_char uniquenick[GP_UNIQUENICK_LEN],

const gsi_char cdkey[GP_CDKEY_LEN],

GPEnum blocking,

GPCallback callback,

void * param );

Return Value

This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.

Parameters

connection

[in] A GP connection interface.

uniquenick

[in] The desired uniquenick It can be up to GP_UNIQUENICK_LEN characters long, including the NUL.

cdkey

[in] An optional CDKey to associate with the uniquenick. If not using CDKeys this should be NULL.

blocking

[in] GP_BLOCKING or GP_NON_BLOCKING

callback

[in] A user supplied callback with an arg type of GPRegisterUniqueNickResponseArg.

param

[in] Pointer to user-defined data. This value will be passed unmodified to the callback function.

Remarks

This function attempts to register a uniquenick and associate it with the local profile. It should only be used if the namespaceID passed to gpInitialize was greater than 0. The backend makes certain checks on a uniquenick before it is allowed to be registered. For details on what is checked, see the "Uniquenick Checks" section at the bottom of "GameSpy Presence SDK.doc".

Unicode Mappings

gpRegisterUniqueNickW and gpRegisterUniqueNickA are UNICODE and ANSI mapped versions of gpRegisterUniqueNick. The arguments of gpRegisterUniqueNickA are ANSI strings; those of gpRegisterUniqueNickW are wide-character strings.

Section Reference: Gamespy Presence SDK

See Also: GPRegisterUniqueNickResponseArg