EOS_RTCAdmin_CopyUserTokenByUserId

EOS API reference page for EOS_RTCAdmin_CopyUserTokenByUserId

Choose your implementation method:

C

C#

Remarks

Fetches a user token for a given user ID when called inside of the OnQueryJoinRoomTokenComplete callback.

Return Value

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

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

  • EOS_NotFound if the user token is not found

See Also

EOS_RTCAdmin_UserToken_Release

Parameters

EOS_RTCAdmin_CopyUserTokenByUserId

Parameter Type And Name

Usage Information

EOS_HRTCAdmin Handle

const EOS_RTCAdmin_CopyUserTokenByUserIdOptions* Options

Structure containing the user ID being accessed

EOS_RTCAdmin_UserToken** OutUserToken

The user token for the given user ID, if it exists and is valid. Use EOS_RTCAdmin_UserToken_Release when finished

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

Remarks

Fetches a user token for a given user ID when called inside of the OnQueryJoinRoomTokenComplete callback. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the user token is not found

Return Value

{Result.Success} if the information is available and passed out in OutUserToken

See Also

{Release}

Parameters

RTCAdmin.RTCAdminInterface.CopyUserTokenByUserId

Parameter Type And Name

Usage Information

CopyUserTokenByUserIdOptions options

Structure containing the user ID being accessed

UserToken outUserToken

The user token for the given user ID, if it exists and is valid. Use EOS_RTCAdmin_UserToken_Release when finished

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