Message Properties

Property Description
ErrNo

Error or Warning message number to return to application for the warning or error.

  • If this is a property in the Notifications section, this is the error number that is sent by the WarningMessageEventEx event when a message from the printer is detected.

  • If this is a property in the GetStatusSettings section of the configuration file, this is the error number that is sent by the errors array when a message from the printer is detected.

Level

Indicates the level of warning.

This property is only found in the Message properties in the Notifications section. Message entries in the GetStatusSettings ignore this property.

This is an indicator of the level, or seriousness, of the message. Possible values are:

  • 1: Non fatal error. ErrNo will be sent by the WarningMessageEventEx as a non-fatal. If no WarningMessageEvent sinks have been set, no action will be taken and the report will continue. If the user aborts in the event sink, the message will be treated as fatal and an exception thrown.

  • 2: Non fatal error. ErrNo will be sent by the WarningMessageEventEx as a non-fatal error. If no WarningMessageEvent sinks have been set, or the user aborts in the event sink, the message will be treated as fatal and an exception will be thrown.

  • 3: Fatal error.  An exception is thrown.

MsgSearch

Used to identify how to search messages returning from the printer for the PrinterMsg string.

Indicates the search methodology for determining which message is returned by the printer. Currently the only possible value is 1: Condition is true if the message from the printer contains the string in the PrinterMsg property.

As this is the default value as well, there is no current need to include the MsgSearch property.  More search methods may be added in the future.

PrinterMsg

String that is searched for in the data returned by the printer that signals an error or warning.

This string is searched for in any response from the printer to determine if this error has occurred.