This function gets suggested uniquenicks from the backend.

GPResult gpSuggestUniqueNick(

GPConnection * connection,

const gsi_char desirednick[GP_UNIQUENICK_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.

desirednick

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

blocking

[in] GP_BLOCKING or GP_NON_BLOCKING

callback

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

param

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

Remarks

This fuction gets a set of suggested nicks based on the desirednick. A request is sent to the backend for suggestions based on the provided desirednick. After getting a response, the callback is called with a list of uniquenicks based on the desirednick. These suggested uniquenicks can then be used in a call to gpNewUser, gpRegisterUniqueNick, or gpSetInfos.

Unicode Mappings

gpSuggestUniqueNickW and gpSuggestUniqueNickA are UNICODE and ANSI mapped versions of gpSuggestUniqueNick. The arguments of gpSuggestUniqueNickA are ANSI strings; those of gpSuggestUniqueNickW are wide-character strings.

Section Reference: Gamespy Presence SDK

See Also: GPSuggestUniqueNickResponseArg