Caché ObjectScript Reference - InterSystems Documentation

$ECODE can also contain error codes that are the same as Caché General System error codes(the error codes returned at the terminal prompt and to the $ZERROR special variable).However, $ECODE appends a “Z” to these error codes, and removes the angle brackets.Thus the $ECODE error ZSYNTAX is a error, ZILLEGAL VALUE is an error, and ZFUNCTION is a error. $ECODE doesnot retain any additional error info for those error codes that provide it; thus ZPROTECT isa error; the additional info component is kept in $ZERROR, but not in$ECODE. For more information about Caché error codes, see $ZERROR; for a completelist, see General System Error Messages in the Caché Error Reference.If an error occurs when $ECODE already contains an error code, Caché appends the codefor the new error to the current $ECODE value as a new piece in a string delimited by commas,as follows:,ZSTORE,M6,ZILLEGAL VALUE,ZPROTECT,In the above case, the most recent error is a error.Error codes accrue in the $ECODE special variable until one of the following happens:• You explicitly clear or set $ECODE.• The length of the accumulated string in $ECODE exceeds the maximum string datalength for your implementation.• You terminate the current process.Clearing or Setting $ECODEYou can clear or set $ECODE with the SET command. For example, you can clear $ECODEby setting it to the null string as follows:SET $ECODE=""Clearing the value of $ECODE also affects error processing flow of control for $ETRAPerror handlers and clears the error stack for your job. See Error Processing in Using CachéObjectScript for more details.You can force an error by setting $ECODE. Setting $ECODE to any non-null value forcesan interpreter error during the execution of a Caché ObjectScript routine. After Caché sets$ECODE to the non-null value that you specify, Caché takes the following steps:1. Generates an error condition (setting $ZERROR to the value )2. Passes control to any error handlers you have established.$ECODECaché ObjectScript Reference 421