EOS_UserInfo_CopyUserInfo

EOS API reference page for EOS_UserInfo_CopyUserInfo

実装方法を選んでください。

C

C#

This function is part of the UserInfo Interface.

Remarks

EOS_UserInfo_CopyUserInfo is used to immediately retrieve a copy of user information based on an Epic Online Services Account ID, cached by a previous call to EOS_UserInfo_QueryUserInfo. If the call returns an EOS_Success result, the out parameter, OutUserInfo, must be passed to EOS_UserInfo_Release to release the memory associated with it.

Return Value

  • EOS_Success if the information is available and passed out in OutUserInfo

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_NotFound if the user info is not locally cached. The information must have been previously cached by a call to EOS_UserInfo_QueryUserInfo

See Also

EOS_UserInfo, EOS_UserInfo_CopyUserInfoOptions, EOS_UserInfo_Release

Parameters

EOS_UserInfo_CopyUserInfo

Parameter Type And Name

Usage Information

EOS_HUserInfo Handle

const EOS_UserInfo_CopyUserInfoOptions* Options

structure containing the input parameters

EOS_UserInfo** OutUserInfo

out parameter used to receive the EOS_UserInfo structure.

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.

Related API Members

This function is part of the UserInfo Interface.

Remarks

EOS_UserInfo_CopyUserInfo is used to immediately retrieve a copy of user information based on an Epic Online Services Account ID, cached by a previous call to EOS_UserInfo_QueryUserInfo. If the call returns an EOS_Success result, the out parameter, OutUserInfo, must be passed to EOS_UserInfo_Release to release the memory associated with it.

Return Value

  • EOS_Success if the information is available and passed out in OutUserInfo

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_IncompatibleVersion if the API version passed in is incorrect

  • EOS_NotFound if the user info is not locally cached. The information must have been previously cached by a call to EOS_UserInfo_QueryUserInfo

See Also

EOS_UserInfo, EOS_UserInfo_CopyUserInfoOptions, EOS_UserInfo_Release

Parameters

UserInfo.UserInfoInterface.CopyUserInfo

Parameter Type And Name

Usage Information

CopyUserInfoOptions options

structure containing the input parameters

UserInfoData outUserInfo

out parameter used to receive the EOS_UserInfo structure.

If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.

Related API Members

タグ