gpProfileSearch
This function searches for profiles based on certain criteria.
- GPResult gpProfileSearch(
- GPConnection * connection,
- const gsi_char nick[GP_NICK_LEN],
- const gsi_char uniquenick[GP_UNIQUENICK_LEN],
- const gsi_char email[GP_EMAIL_LEN],
- const gsi_char firstname[GP_FIRSTNAME_LEN],
- const gsi_char lastname[GP_LASTNAME_LEN],
- int icquin,
- GPEnum blocking,
- GPCallback callback,
- void * param );
Routine | Required Header | Distribution |
---|---|---|
gpProfileSearch | <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.
- nick
- [in] If not NULL or "", search for profiles with this nick.
- uniquenick
- [in] If not NULL or "", search for profiles with this uniquenick.
- [in] If not NULL or "", search for profiles with this email.
- firstname
- [in] If not NULL or "", search for profiles with this firstname.
- lastname
- [in] If not NULL or "", search for profiles with this lastname.
- icquin
- [in] If not 0, search for profiles with this icquin.
- blocking
- [in] GP_BLOCKING or GP_NON_BLOCKING
- callback
- [in] A user supplied callback with an arg type of GPProfileSearchResponseArg.
- 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 attempts to find all profiles that match the search criteria. A profile matches the provided search criteria only if it’s corresponding values are the same as those provided. Currently, there is no substring matching, and the criteria is case-sensitive.
When the search is complete, the callback will be called.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
gpProfileSearch | gpProfileSearchA | gpProfileSearchW |
gpProfileSearchW and gpProfileSearchA are UNICODE and ANSI mapped versions of gpProfileSearch. The arguments of gpProfileSearchA are ANSI strings; those of gpProfileSearchW are wide-character strings.
Section Reference: Gamespy Presence SDK
See Also: GPProfileSearchResponseArg