EOS API reference page for EOS_UserInfo_QueryUserInfo

2 mins to read

This function is part of the UserInfo Interface.


EOS_UserInfo_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 EOS_UserInfo_CopyUserInfo to receive an EOS_UserInfo containing the available information.

See Also

EOS_UserInfo, EOS_UserInfo_CopyUserInfo, EOS_UserInfo_QueryUserInfoOptions, EOS_UserInfo_OnQueryUserInfoCallback



Parameter Type And NameUsage Information
EOS_HUserInfo Handle
const EOS_UserInfo_QueryUserInfoOptions* Optionsstructure containing the input parameters
void* ClientDataarbitrary data that is passed back to you in the CompletionDelegate
const EOS_UserInfo_OnQueryUserInfoCallback CompletionDelegatea callback that is fired when the async operation completes, either successfully or in error

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_UserInfo_OnQueryUserInfoCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed to EOS_UserInfo_QueryUserInfo

Callback Parameters


Parameter Type And NameUsage Information
const EOS_UserInfo_QueryUserInfoCallbackInfo* DataA EOS_UserInfo_QueryUserInfoCallbackInfo containing the output information and result