Edit

Option attributes for all features

  • Article

Important

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 the Print support app design guide.

The following table lists, in alphabetic order, the option attributes available for all features and describes their parameters.

Attribute name Attribute parameter Comments
*Command A CmdSelect option selection command, specifying the command string that must be sent to the printer in order to select the option. Required
*DisabledFeatures LIST of feature name strings, identifying features that should be disabled if the option is selected.

Currently DUPLEX and COLLATE features are supported. This option attribute must be used in a feature that has FeatureType set to PRINTER_PROPERTY.		 Optional.

Listed features cannot have *Installable? set to TRUE. For more information, see Handling Installable Features and Options.
*HelpIndex Numeric value representing an index into the help file specified by the *HelpFile root-level-only attribute. (Also a feature attribute.)

Index value cannot be zero or -1.
*Installable? TRUE or FALSE, indicating whether the option is installable. (FALSE means always installed.)

For more information, see Handling Installable Features and Options.		 Optional. If not specified, the default value is FALSE. (Also a feature attribute.)
*InstallableFeatureName Text string that is displayed to ask the user whether an installable option is actually installed.

For more information, see Handling Installable Features and Options.		 Required if *Installable? is TRUE and*rcInstallableFeatureNameID is not specified. (Also a feature attribute.)
*Name Text string used as the option's display name on the printer's property sheet. Optional. If not specified, then *rcNameID must be specified. (Also a feature attribute.)
*OptionID Numeric value representing a unique option identifier that Unidrv stores in the printer's DEVMODEW structure. For use only with the PaperSize, InputSlot, Halftoning, and MediaType features. Value is stored in the DEVMODE structure's dmPaperSize, dmDefaultSource, dmDitherType, or dmMediaType member, respectively. Optional. If not specified, Unidrv assigns an identifier value (>256). To avoid conflicts with Unidrv-assigned identifiers, the specified value must be greater than 512.
*rcIconID Resource ID of an icon resource associated with the option. Optional. If not specified, Unidrv does not display an icon for the option on the printer property sheet. (Also a feature attribute.)
*rcInstallableFeatureNameID Resource ID of a text string that is displayed to ask the user whether an installable option is actually installed.

For more information, see Handling Installable Features and Options.		 Required if *Installable? is TRUE and *InstallableFeatureName is not specified. (Also a feature attribute.)
*rcNameID Resource ID of string resource representing the option name. Optional. If not specified, then *Name must be specified. (Also a feature attribute.)

For standard options of the PaperSize feature only, setting this attribute to RCID_DMPAPER_SYSTEM_NAME causes Unidrv to use a predefined option name string.

For examples, see the sample GPD files.