gpGetUserNicks
This function gets the nicknames for a given e-mail/password (which identifies a user).
- GPResult gpGetUserNicks(
- GPConnection * connection,
- const gsi_char email[GP_EMAIL_LEN],
- const gsi_char password[GP_PASSWORD_LEN],
- GPEnum blocking,
- GPCallback callback,
- void * param );
Routine | Required Header | Distribution |
---|---|---|
gpGetUserNicks | <gp.h> | SDKZIP |
Return Value
This function returns GP_NO_ERROR upon success. Otherwise a valid GPResult is returned.
Parameters
- connection
- [in] A GP connection interface. (Does not have to be connected)
- [in] The account e-mail address.
- password
- [in] The account password.
- blocking
- [in] GP_BLOCKING or GP_NON_BLOCKING
- callback
- [in] A user-supplied callback with an arg type of GPGetUserNicksResponseArg
- param
- [in] Pointer to user-defined data. This value will be passed unmodified to the callback function.
Remarks
This function contacts the Search Manager and gets a list of this user's nicks (profiles).
If you are unsure if the email address provided to this function is a valid email address, call gpIsValidEmail first.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
gpGetUserNicks | gpGetUserNicksA | gpGetUserNicksW |
gpGetUserNicksW and gpGetUserNicksA are UNICODE and ANSI mapped versions of gpGetUserNicks. The arguments of gpGetUserNicksA are ANSI strings; those of gpGetUserNicksW are wide-character strings.
Section Reference: Gamespy Presence SDK
See Also: GPGetUserNicksResponseArg, gpIsValidEmail