^HZ - Display Description Information

Sends printer status, configuration or object descriptions back to the host as XML.

^HZ is the XML form of the other query commands. One selector chooses between the printer's format settings, its object directory, one object's details, its status, or all of them. The reply is XML rather than a positional string. Only the O selector reads the remaining arguments. Every other selector ignores them, so ^HZA is a complete command.

Syntax

^HZb,d:o.x,l

Support

Recognised, deliberately skippedparsed: none · state: none · rendered: none

Accepted and skipped, because it configures the printer rather than the label. It cannot change the rendered output, and Labelary skips it too.

Returns an XML description of the printer, a directory listing or one object over the printer's link. Every selector is a report, so none of them changes the label. The renderer does not parse this command. It reports IGNORED_COMMAND at info severity, which does not reach X-Warnings. Labelary is also silent, so the rendered label is identical in both engines. — not pinned by a test

Labelary renders this command.

Parameters

bSelectorrequired · one of a set

Which description to return. No default exists; a missing selector leaves nothing to select.

Invalid value: enough to make the whole command be ignored. The guide states that a missing or invalid selector makes the printer ignore the whole command.
Test coverage: No documented value is exercised by a test (A, F, L, O, R). The invalid-value rule is not pinned by a test.

A: All information
F: Format configuration
L: Directory listing
O: Information about one object
R: Printer status

dStorage deviceoptional · single character

Which memory device the object lives on: R:, E:, B: or A:. Read only when b is O.

Default: R:
Invalid value: not documented, and we have not measured it. The renderer does not parse or measure this command.
Test coverage

oObject nameoptional · text

Name of the object to describe, one to eight characters, or up to sixteen when l is Y. Read only when b is O.

Default: UNKNOWN
Invalid value: not documented, and we have not measured it. The renderer does not parse or measure this command.
Test coverage

xExtensionoptional · text

Extension of the object to describe. The guide lists .FNT, .GRF, .PNG, .ZPL, .DAT, .ZOB and .STO. Read only when b is O.

Default: .GRF
Invalid value: not documented, and we have not measured it. The renderer does not parse or measure this command.
Test coverage

lLong file namesoptional · Y or N

Whether the reply holds names as sixteen characters rather than eight. Read only when b is O; Y needs firmware V60.13.0.5 or later.

Default: N
Invalid value: not documented, and we have not measured it. The renderer does not parse or measure this command.
Test coverage: No documented value is exercised by a test (Y, N).

Y: Sixteen-character file names
N: Eight-character file names (default)

Behavior

The guide documents ^HZ as two format lines: ^HZb for the four report selectors, and ^HZO,d:o.x,l for the individual-object form. The single syntax line above covers both, because the object form is the selector O with arguments after it. The guide's parameter table names the selector values in lower case, and its own worked example uses ^HZO,R:SAMPLE.GRF in upper case. Labelary documents them in upper case, and this page follows Labelary.

The guide is explicit about one edge: a missing or invalid selector makes the printer ignore the whole command, and no default report applies.

None of the five reports describes anything a render request has, and no link carries XML. The renderer ignores the command, and the page is unchanged. It reports IGNORED_COMMAND at info severity, which does not reach X-Warnings. Labelary is also silent. The renderer does not parse the argument, so it ignores ^HZQ and a bare ^HZ exactly as it ignores ^HZA, and does not reject them as the guide describes.

Example

Asking for everything, on a format that also prints. Only the printing has any effect.

^XA
^HZA
^FO50,50^A0N,40,40^FDXML report^FS
^XZ

Open in viewer

The individual-object form, with long file names enabled:

^XA
^HZO,R:SAMPLE.GRF,Y
^FO50,50^A0N,40,40^FDObject report^FS
^XZ