gpGetInfo
This function gets info on a particular profile.
- GPResult gpGetInfo(
- GPConnection * connection,
- GPProfile profile,
- GPEnum checkCache,
- GPEnum blocking,
- GPCallback callback,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| gpGetInfo | <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.
- profile
- [in] The profile ID of the user to get info on.
- checkCache
- [in] When set to GP_CHECK_CACHE the SDK will use the currently known info.
- blocking
- [in] GP_BLOCKING or GP_NON_BLOCKING
- callback
- [in] A user-supplied callback with an argument type of GPGetInfoResponseArg
- param
- [in] Pointer to user-defined data. This value will be passed unmodified to the callback function.
Remarks
This function gets profile info for the profile object profile. When the info has been retrieved, the callback will be called.. If info-caching is enabled, the info may be available locally, in which case it will be returned immediately if checkCache is GP_CHECK_CACHE. Otherwise, the server will be contacted for the info. If the server needs to be contacted, then the function will return immediately in non-blocking mode.
If info-caching is enabled, any info retrieved from the server will be cached.
Section Reference: Gamespy Presence SDK
See Also: GPGetInfoResponseArg