Command attributes

  • Article

Important

The modern print platform is Windows' preferred means of communicating with printers. We recommend that you use Microsoft's IPP inbox class driver, along with Print Support Apps (PSA), to customize the print experience in Windows 10 and 11 for printer device development.

For more information, see Modern print platform and the Print support app design guide.

When specifying a printer command, you use attributes to provide Unidrv with the following information:

  • The escape sequence that causes the hardware to perform the operation, if the operation is implemented in printer hardware.

  • The callback identifier and parameters required by the IPrintOemUni::CommandCallback method, if the operation is implemented in a rendering plug-in.

  • The order in which the command should be sent, relative to other commands.

The following table lists the command attributes in alphabetic order and describes their parameters.

Attribute name Attribute parameter Comments
CallbackID Positive numeric value, passed to the rendering plug-in's IPrintOemUni::CommandCallback method as its dCmdCbID argument. Required for dynamically generated printer commands. Not valid if Cmd is specified.
Cmd Text string containing a printer command escape sequence, specified using the command string format. Required unless CallbackID is specified.
NoPageEject? TRUE or FALSE, indicating whether executing the command causes the printer to eject the current physical page.

Used only if Order specifies the DOC_SETUP section and if DUPLEX printing is enabled. To avoid premature page ejection between duplexed document pages, Unidrv only issues commands with this attribute set to TRUE, if possible.		 Optional. If not specified, the default value is FALSE, meaning the command might cause page ejection.

Must not be TRUE if a command causes side effects (that is, if the command modifies printer settings outside of those controlled by commands with NoPageEject? set to TRUE).
Order Section name and order number, as described in Command Execution Order. Valid only with configuration commands and customized option commands, unless stated in the command description.
Params List of standard variables, passed to the rendering plug-in's IPrintOemUni::CommandCallback method in the EXTRAPARAM structure that is passed as its pdwParams argument. Valid only if CallbackID is also specified.