libaaruformat 1.0 Aaru Data Preservation Suite - Format Library

Loading...
Searching...
No Matches
DumpHardwareEntry Struct Reference

Per-environment length table describing subsequent UTF-8 strings and optional extent array. More...

`#include <aaruformat/structs/dump.h>`

## Data Fields
uint32_t | manufacturerLength
| Length in bytes of manufacturer UTF-8 string.
uint32_t | modelLength
| Length in bytes of model UTF-8 string.
uint32_t | revisionLength
| Length in bytes of revision / hardware revision string.
uint32_t | firmwareLength
| Length in bytes of firmware version string.
uint32_t | serialLength
| Length in bytes of device serial number string.
uint32_t | softwareNameLength
| Length in bytes of dumping software name string.
uint32_t | softwareVersionLength
| Length in bytes of dumping software version string.
uint32_t | softwareOperatingSystemLength
| Length in bytes of host operating system string.
uint32_t | extents
| Number of DumpExtent records following the strings (0 = none).

## Detailed Description

Per-environment length table describing subsequent UTF-8 strings and optional extent array.

Immediately after this structure the variable-length UTF‑8 strings appear in the documented order, each present only if its corresponding length is non-zero. No padding is present between strings. When all strings are consumed, an array of DumpExtent follows if extents > 0.

All length fields measure bytes (not characters) and exclude any in-memory NUL terminator added by the reader.

Typical semantics:

- manufacturer/model/revision/firmware/serial identify the hardware device.
- softwareName/softwareVersion/softwareOperatingSystem identify the acquisition software environment.
- extents list which logical ranges this environment actually dumped (useful for multi-device composites).

Definition at line 112 of file dump.h.

## Field Documentation

## ◆ extents

uint32_t DumpHardwareEntry::extents

Number of DumpExtent records following the strings (0 = none).

Definition at line 122 of file dump.h.

Referenced by aaruf_get_dumphw(), aaruf_set_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ firmwareLength

uint32_t DumpHardwareEntry::firmwareLength

Length in bytes of firmware version string.

Definition at line 117 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ manufacturerLength

uint32_t DumpHardwareEntry::manufacturerLength

Length in bytes of manufacturer UTF-8 string.

Definition at line 114 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ modelLength

uint32_t DumpHardwareEntry::modelLength

Length in bytes of model UTF-8 string.

Definition at line 115 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ revisionLength

uint32_t DumpHardwareEntry::revisionLength

Length in bytes of revision / hardware revision string.

Definition at line 116 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ serialLength

uint32_t DumpHardwareEntry::serialLength

Length in bytes of device serial number string.

Definition at line 118 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ softwareNameLength

uint32_t DumpHardwareEntry::softwareNameLength

Length in bytes of dumping software name string.

Definition at line 119 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ softwareOperatingSystemLength

uint32_t DumpHardwareEntry::softwareOperatingSystemLength

Length in bytes of host operating system string.

Definition at line 121 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

## ◆ softwareVersionLength

uint32_t DumpHardwareEntry::softwareVersionLength

Length in bytes of dumping software version string.

Definition at line 120 of file dump.h.

Referenced by aaruf_get_dumphw(), process_dumphw_block(), and write_dumphw_block().

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

- include/aaruformat/structs/dump.h