zpl.tools
Graphics and images

^HG - Host Graphic

Uploads a stored graphic back to the host.

^HG sends a stored graphic out of the printer and back up the link to the host, so a graphic can reach an archive or another printer. A rendering API has no host, so the renderer parses the command and ignores it. It draws nothing, and a label that carries it renders exactly as a label without it.

Syntax

^HGd:o.x

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.

Sends data back over the printer's serial link, which means nothing for a rendering API. The renderer ignores it, as Labelary does. — not pinned by a test

Labelary renders this command.

Parameters

dStorage deviceoptional · single character

Which memory device to read from.

Default
search priority — R:, then E:, B:, A:
Invalid value
discarded, and the default applies
Test coverage
The invalid-value rule is not pinned by a test.
oObject nameoptional · text

Name of the graphic to upload.

Default
UNKNOWN
Invalid value
discarded, and the default applies
Test coverage
The invalid-value rule is not pinned by a test.
xExtensionoptional · text

Extension of the object to upload.

Default
.GRF
Invalid value
discarded, and the default applies
Test coverage
The invalid-value rule is not pinned by a test.

Behavior

The reply travels over the printer's serial or network connection as a ~DG-formatted download. That is what makes the round trip work, because the reply goes straight into another printer. ^HY is the general form for any object, and ^HW lists what memory holds.

The renderer neither reads nor writes a graphic for ^HG, so ^HG does not extract a graphic from a conversion request. The renderer ignores it, Labelary ignores it, and both render the same pixels.

Example

^HG alongside ordinary label content, which prints unaffected:

^XA
^HGR:LOGO.GRF
^FO50,50^A0N,30,30^FDthe upload is skipped^FS
^XZ

Open in viewer