EOS API reference page for EOS_RTCAdmin_CopyUserTokenByIndex



Fetches a user token when called inside of the OnQueryJoinRoomTokenComplete callback. initiating the query.

The order of the tokens doesn't necessarily match the order of the EOS_ProductUserId array specified in the EOS_RTCAdmin_QueryJoinRoomTokenOptions when

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




Parameter Type And NameUsage Information
EOS_HRTCAdmin Handle
const EOS_RTCAdmin_CopyUserTokenByIndexOptions* OptionsStructure containing the index being accessed
EOS_RTCAdmin_UserToken** OutUserTokenThe user token for the given index, 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.