This function is part of the UserInfo Interface.
Remarks
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
EOS_UserInfo_QueryUserInfoByDisplayName
Parameter Type And Name | Usage Information |
---|---|
EOS_HUserInfo Handle | |
const EOS_UserInfo_QueryUserInfoByDisplayNameOptions* Options | structure containing the input parameters |
void* ClientData | arbitrary data that is passed back to you in the CompletionDelegate |
const EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback CompletionDelegate | a 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_OnQueryUserInfoByDisplayNameCallback to report the results of its operation.
Callback Remarks
Function prototype definition for callbacks passed to EOS_UserInfo_QueryUserInfo
Callback Parameters
EOS_UserInfo_OnQueryUserInfoByDisplayNameCallback
Parameter Type And Name | Usage Information |
---|---|
const EOS_UserInfo_QueryUserInfoByDisplayNameCallbackInfo* Data | A EOS_UserInfo_QueryUserInfoByDisplayNameCallbackInfo containing the output information and result |