IDLitIMessaging::SignalError

Syntax | Arguments | Keywords | Version History

The IDLitIMessaging::SignalError procedure method is used to signal an error in the system. No user interface is displayed to the user, but the error is registered with the system, made the current error, and recorded by the iTool log service (if enabled).

Note
If this method is used to signal an error, the IDLitIMessaging::ErrorMessage method can be called with the /USE_LAST_ERROR keyword to use the information set by this method.

Syntax

Obj->[IDLitIMessaging::]SignalError, StrMessage [, CODE=integer] [, SEVERITY=integer]

Arguments

StrMessage

A scalar string or string array containing a description of the error.

Keywords

CODE

Set this keyword to an integer that represents an error code that can be associated with the error. Error codes can be any integer value specified by the iTool developer.

SEVERITY

Set this keyword to the severity code to use for this message. The system recognizes the following values:

0 = Informational

1 = Warning

2 = Error

Version History


6.0	Introduced