Archive::ArchiveListFileResult Struct Reference

#include <ArchiveReaderAPI.h>

Public Member Functions
	operator bool () const

Public Attributes
AZ::IO::Path	m_relativeFilePath
	The file path of the file being queried.
ArchiveFileToken	m_filePathToken { InvalidArchiveFileToken }
	Identifier token that allows for quicker lookup of the file in the archive TOC.
Compression::CompressionAlgorithmId	m_compressionAlgorithm { Compression::Uncompressed }
	The compression algorithm ID representing the compression algorithm used to store the file.
AZ::u64	m_uncompressedSize {}
	The uncompressed size of the removed file.
AZ::u64	m_compressedSize {}
ArchiveHeader::TocOffsetU64	m_offset {}
AZ::Crc32	m_crc32 {}
	CRC32 checksum of the uncompressed file data.
ResultOutcome	m_resultOutcome
	Stores error and information messages with listing the contents of the file.

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::ArchiveListFileResult::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_compressedSize

AZ::u64 Archive::ArchiveListFileResult::m_compressedSize {}

the compressed size of the removed file INFO: This value will be a multiple of 512

m_offset

ArchiveHeader::TocOffsetU64 Archive::ArchiveListFileResult::m_offset {}

The raw offset of the file in the archive 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/Clients/ArchiveReaderAPI.h
• Gems/Archive/Code/Include/Archive/Clients/ArchiveReaderAPI.inl