RAISEERROR Function

Prints a message to the run log.

Category: Logging
Returned data type: Integer
Note: There is no return value for this function since an error occurs when this is called and the expression stops processing.

Syntax

<boolean>RAISEERROR(string usererror)

Required Argument

usererror

is a string that is printed to the jobs output.

Details

The RAISEERROR function raises a user-defined error. Users can define a condition and then use RAISEERROR to stop the job and return an error message when the condition occurs. This is useful for evaluating problems unique to an installation. The user can then search for the error message to determine whether the associated condition was responsible for stopping the job.

Example

raiseerror("user defined error")