Archive::ArchiveWriterFileSettings Struct Reference

#include <ArchiveWriterAPI.h>

Public Attributes
AZ::IO::PathView	m_relativeFilePath
Compression::CompressionAlgorithmId	m_compressionAlgorithm { Compression::Uncompressed }
ArchiveWriterFileMode	m_fileMode { ArchiveWriterFileMode::AddNew }
ArchiveFilePathCase	m_fileCase { ArchiveFilePathCase::Lowercase }
const Compression::CompressionOptions *	m_compressionOptions {}

Detailed Description

Settings for controlling how an individual file is added to an archive. It supports specification of the compression algorithm, the relative path it should be in the archive file located at within the archive, whether to allow updating an existing archive file at the same path, etc... NOTE: The relative file path will be lowercased by default based on the ArchiveFileCase enum This due to the Archiving System supporting both case-preserving(Windows, MacOS) and case-sensitive systems such as Linux

Member Data Documentation

m_compressionOptions

const Compression::CompressionOptions* Archive::ArchiveWriterFileSettings::m_compressionOptions {}

Pointer to a compression options derived struct This can be used to supply custom compression options to the compressor the Archive Writer users

---

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

• Gems/Archive/Code/Include/Archive/Tools/ArchiveWriterAPI.h