Archive::ArchiveRemoveFileResult Struct Reference

#include <ArchiveWriterAPI.h>

Public Member Functions
	operator bool () const

Public Attributes
AZ::IO::Path	m_relativeFilePath
	File path of the removed file.
Compression::CompressionAlgorithmId	m_compressionAlgorithm { Compression::Uncompressed }
	Compression algorithm ID that that file was compressed or Compression::Uncompressed if not.
AZ::u64	m_uncompressedSize {}
	The uncompressed size of the removed file.
AZ::u64	m_compressedSize {}
	the compressed size of the removed file
ArchiveHeader::TocOffsetU64	m_offset {}
ResultOutcome	m_resultOutcome
	Stores any error messages that occur when removing the file from the archive.

Detailed Description

Returns a result structure that indicates if removal of a content file from the archive was successful Metadata about the file is returned, such as its file path, compressed algorithm ID offset from the beginning of the raw file data blocks, uncompressed size and compressed size

Member Function Documentation

operator bool()

Archive::ArchiveRemoveFileResult::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_offset

ArchiveHeader::TocOffsetU64 Archive::ArchiveRemoveFileResult::m_offset {}

The raw offset of the file in the ArchiveFile from the beginning of the raw file data block As the ArchiveHeader is 512-byte aligned to the beginning of the file this value is at least 512, NOTE: The TocOffsetU64 structure is used to enforce that the value is >= 512

---

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

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