EASIError()

Description

EASIError() is used to raise an error in the same manner as those raised internally by intrinsics and statements.

Call Signature

void EASIError ( int error_number [, string error_message [, double/string arg] ] )

Return Value

void

This has no return value.

Arguments

int error_number:

Integer value for the error to be raised. This is the value that will be returned by the intrinsic F$ERRNUM() if the error is trapped after it is raised.

[ string error_message ]:

An optional error message corresponding to the error number. The error message can be formatted using C-style format specifiers. If no message is given, then the default message "User generated error" will be used.

[ double/string arg ]:

Optional arguments to match the format specifiers in error_message.

Example

Raise an error with customized message.

 call EASIError( 900, "Invalid data" )
 call EASIError( 901, "File %s is read-only", file_name )

Raise an error using with default message.

 call EASIError( 902 )

See also

F$ERRNUM()

ReCastEASIError()