This function is used to establish a connection to the server. It establishes a connection with an existing profile, which is identified based on the uniquenick and is validated by the password.

GPResult gpConnectUniqueNick(

GPConnection * connection,

const gsi_char uniquenick[GP_UNIQUENICK_LEN],

const gsi_char password[GP_PASSWORD_LEN],

GPEnum firewall,

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 interface object initialized with gpInitialize.

uniquenick

[in] The uniquenick.

password

[in] The profile password.

firewall

[in] GP_FIREWALL or GO_NO_FIREWALL. This option may limit the users ability to send files.

blocking

[in] GP_BLOCKING or GP_NON_BLOCKING

callback

[in] A user-supplied callback with an arg type of GPConnectResponseArg

param

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

Remarks

This function establishes a connection with the server. If the local machine is behind a firewall, the firewall parameter should be set to GP_FIREWALL so that buddy messages can be sent through the server.
gpDisconnect should be called when this connection is ready to be disconnected..
When the connection is complete, the callback will be called.
This function should only be used in a custom namespace that does not expire uniquenicks. This is because if a uniquenick expires and is then taken by another user, the original user will no longer be able to login using that uniquenick.

Unicode Mappings

gpConnectUniqueNickW and gpConnectUniqueNickA are UNICODE and ANSI mapped versions of gpConnectUniqueNick. The arguments of gpConnectUniqueNickA are ANSI strings; those of gpConnectUniqueNickW are wide-character strings.

Section Reference: Gamespy Presence SDK

See Also: GPConnectResponseArg