Cancel Print Job Queue Action

Cancel and remove all print jobs associated with the specified printer.

A YAML reference document is available that provides complete details about the specific properties for each action and describes how to combine actions into groups and create arrays of actions to be sent as one script to the server. The YAML actions reference is provided as follows:

Action: ClearPrintQueueAction

Properties

Printer = string.Empty[get, set]

string

Specifies the printer whose associated print jobs are to be canceled.

For BarTender Cloud printing, the printer is the internet printer that is shared by the BarTender Print Gateway service. The printer ID must follow these rules:

  • Use the "printer:" prefix.

  • Remove the UNC "\\" prefix.

  • Replace all spaces with underscores.

  • Replace all backslashes () in the path with slashes (/).

For example, to specify the following printer:

\\mypc.seagullscientific.com\Zebra 110Xi4(300 dpi)

Use the following printer ID:

printer:mypc.seagullscientific.com/Zebra_110Xi4(300_dpi)

Name[get, set]

string

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description[get, set]

string

Specifies the description. The default value is "".

RunType[get, set]

ActionRunType

Runs the action by using one of the following types:

  • Always (default)

  • Never

IgnoreErrors[get, set]

bool

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries[get, set]

int

Specifies the number of times the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval[get, set]

int

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.

Example

ClearPrintQueueAction:

Printer: printer:mypc.corp.seagullscientific.com/Zebra_S4M_(203_dpi)_-_ZPL

Name: Cancel Print Job Queue

# And more common action properties

...