This function is part of the [UserInfo Interface](Interfaces/UserInfo).
EOS_UserInfo_QueryUserInfoByDisplayName is used to start an asynchronous query to retrieve user information by display name. This can be useful for getting the EOS_EpicAccountId for a display name.
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_QueryUserInfoByDisplayNameOptions, EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback
Parameters
UserInfo.UserInfoInterface.QueryUserInfoByDisplayName
|
Parameter Type And Name
|
Usage Information
|
|
QueryUserInfoByDisplayNameOptions options
|
structure containing the input parameters
|
|
object clientData
|
arbitrary data that is passed back to you in the CompletionDelegate
|
|
OnQueryUserInfoByDisplayNameCallback 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 void* 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 EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback to report the results of its operation.
Function prototype definition for callbacks passed to EOS_UserInfo_QueryUserInfo
Callback Parameters
UserInfo.OnQueryUserInfoByDisplayNameCallback
|
Parameter Type And Name
|
Usage Information
|
|
QueryUserInfoByDisplayNameCallbackInfo data
|
A EOS_UserInfo_QueryUserInfoByDisplayNameCallbackInfo containing the output information and result
|