Skip to main content

setPrinterSettings

Before v4.0, this method was called setSettings.

Modify the settings of the printer.

Parameter​

KeyTypeDescription
settingsobjectA partial Settings object. Any settings not included remain unchanged.
printerstringPrinter ID. Required if more than one printer is available.

Return value​

None

info

The available settings depend on the software version. Settings may be added, removed or renamed when software is updated, so use the keys that getPrinterSettings returns on the same version.

A setting the software doesn't recognize, or a value of the wrong type, is ignored rather than rejected, and the request still succeeds. To check that a change took effect, read the settings back with getPrinterSettings.