Open 3D Engine Archive Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Public Attributes | List of all members
Archive::ArchiveAddFileResult Struct Reference

#include <ArchiveWriterAPI.h>

Public Member Functions

 operator bool () const
 

Public Attributes

AZ::IO::Path m_relativeFilePath
 
ArchiveFileToken m_filePathToken { InvalidArchiveFileToken }
 
Compression::CompressionAlgorithmId m_compressionAlgorithm { Compression::Uncompressed }
 
ResultOutcome m_resultOutcome
 Stores any error messages that occur when adding the file from the archive.
 

Detailed Description

Returns result data around operation of adding a stream of content data to an archive file

Member Function Documentation

◆ operator bool()

Archive::ArchiveAddFileResult::operator bool ( ) const
inlineexplicit

returns if adding a stream of data to a file within the archive has succeeded it does by checking that the ArchiveFileToken != InvalidArchiveFileToken

Member Data Documentation

◆ m_compressionAlgorithm

Compression::CompressionAlgorithmId Archive::ArchiveAddFileResult::m_compressionAlgorithm { Compression::Uncompressed }

Compression Algorithm ID that was used to compress the added file NOTE: This will be different that the ArchiveWriterFileSettings::m_compressionAlgorithm if the the compression algorithm is not registered or the CompressionRegistrar is not available. In that case, the file will be stored uncompressed

◆ m_filePathToken

ArchiveFileToken Archive::ArchiveAddFileResult::m_filePathToken { InvalidArchiveFileToken }

Token that can be used to query or remove the file added file from the mounted Archive This is only valid for the specific ArchiveWriter instance

◆ m_relativeFilePath

AZ::IO::Path Archive::ArchiveAddFileResult::m_relativeFilePath

File path of the added file NOTE: This is the file path as added to the Archive FilePath Blob Table It will be different than the file path specified in ArchiveWriterFileSettings::m_relativeFilePath if the ArchiveWriterFileSettings::m_fileCase options causes the file path case to change

The documentation for this struct was generated from the following files: