This function is part of the UserInfo Interface.
{QueryUserInfo} is used to start an asynchronous query to retrieve information, such as display name, about another account.
Once the callback has been fired with a successful ResultCode, it is possible to call {CopyUserInfo} to receive an {UserInfoData} containing the available information.
See Also
{UserInfoData}, {CopyUserInfo}, {QueryUserInfoOptions}, {OnQueryUserInfoCallback}
Parameters
UserInfo.UserInfoInterface.QueryUserInfo
Parameter Type And Name
|
Usage Information
|
QueryUserInfoOptions options
|
structure containing the input parameters
|
object clientData
|
arbitrary data that is passed back to you in the CompletionDelegate
|
OnQueryUserInfoCallback completionDelegate
|
a callback that is fired when the async operation completes, either successfully or in error
|
This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate
parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object
parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.
Because this function is asynchronous, it employs a callback of type UserInfo.OnQueryUserInfoCallback to report the results of its operation.
Function prototype definition for callbacks passed to {UserInfoInterface.QueryUserInfo}
Callback Parameters
UserInfo.OnQueryUserInfoCallback
Parameter Type And Name
|
Usage Information
|
QueryUserInfoCallbackInfo data
|
A EOS_UserInfo_QueryUserInfoCallbackInfo containing the output information and result
|