^HW - Host Directory List

Overview

The ^HW command transmits a formatted directory listing of objects stored in a specific memory device back to the host computer. Returns object names, sizes, and extension information for all stored items in the requested memory area.

Syntax

^HWd:

Parameters

• d = Storage device to list (required)
  • R: = RAM (DRAM)
  • B: = Flash Card (PCMCIA)
  • E: = Flash Memory (onboard)

Description

• Lists all stored objects on device
• Returns formatted ASCII strings
• Fixed-length format for easy parsing
• Includes object names, sizes, and flags

Return Format

<STX><CR><LF>
- DIR d:
xx<CR><LF>
* objectname.ext  size   flags<CR><LF>
...
- xxxxxxx bytes free<CR><LF>
<ETX>

Field Descriptions

• objectname = 8 characters
• period = .
• extension = 3 characters
• size = 6 character field
• flags = 3 character option flags

Examples

List RAM Contents

^XA
^HWR:
^XZ

Response:

<STX><CR><LF>
- DIR R:
00<CR><LF>
* LOGO.GRF      00150   123<CR><LF>
* SAMPLE.GRF    00200   000<CR><LF>
- 0000780 bytes free<CR><LF>
<ETX>

List Flash Card Contents

^XA
^HWB:
^XZ

Usage Notes

• Fixed-length line format enables programmatic parsing
• Each object line includes:
  • Asterisk (*) prefix
  • Space separator
  • 8-character object name
  • Period (.)
  • 3-character extension
  • 2 spaces
  • 6-digit size in bytes
  • 2 spaces
  • 3-character flags
• Processed in order received (queued operation)
• Can be used in stand-alone file or within format
• Useful for inventory and debugging

Parsing Example

* LOGO.GRF      00150   123
  123456789012345678901234567890
          1111111111222222222233

Related Commands

• ^WD - Print Directory on Label
• ^TO - Transfer Object
• ^ID - Image Delete
• ~HM - Host Memory Status

See Also

• Print Directory on Label (^WD)
• Host Memory Status (~HM)
• Transfer Object (^TO)