API reference
API reference
Select your platform
No SDKs available
No versions available

FOvrAssetFileDownloadCancelResult Struct

An AssetFileDownloadCancelResult represents the result of a canceled download action of an asset file. You can cancel a download of an asset file by using UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelById() or UOvrRequestsBlueprintLibrary::AssetFile_DownloadCancelByName(). The result contains three fields which are the asset file ID(use field FOvrAssetFileDownloadCancelResult::AssetId to access), the file path, and success status of the canceled download.

Constructors

FOvrAssetFileDownloadCancelResult ()
This is the default constructor for the struct, which initializes the ::ovrAssetFileDownloadCancelResultHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrAssetFileDownloadCancelResult::FOvrAssetFileDownloadCancelResult()
FOvrAssetFileDownloadCancelResult ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrAssetFileDownloadCancelResult::FOvrAssetFileDownloadCancelResult(ovrAssetFileDownloadCancelResultHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrAssetFileDownloadCancelResultHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

AssetFileId : FOvrId
DeprecatedYou can use field FOvrAssetFileDownloadCancelResult::AssetId to retrieve the ID of the asset file instead.
Signature
FOvrId FOvrAssetFileDownloadCancelResult::AssetFileId
AssetId : FOvrId
ID of the asset file. NOTE: this does not represent the ID of the asset.
Signature
FOvrId FOvrAssetFileDownloadCancelResult::AssetId
Filepath : FString
File path of the asset file.
Signature
FString FOvrAssetFileDownloadCancelResult::Filepath
Success : bool
You can use this to determine whether the cancel request of downloading an asset file has succeeded.
Signature
bool FOvrAssetFileDownloadCancelResult::Success

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrAssetFileDownloadCancelResult::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrAssetFileDownloadCancelResult::Update(ovrAssetFileDownloadCancelResultHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrAssetFileDownloadCancelResultHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void