userExitCode

Type: Integer

The userExitCode property of the Node class contains a value returned by your applications when a JADE program (for example, jade.exe, jadapp, jadrap.exe, jaded, and so on) exits. The default value is zero (0). For more details, see Appendix A, "Exit Values", in the JADE Installation and Configuration Guide.

You can use this property, for example, to set a non-zero exit code that can then be checked in a batch file by using the ERRORLEVEL keyword to check for appropriate userExitCode values, as shown in the following example.

begin
    beginTransaction;
    node.userExitCode := 123;
    commitTransaction;
    terminate;
end;

The specified value is returned only if the JADE program would have normally returned zero (0); that is, if JADE wants to return a non-zero exit value, the JADE value takes precedence over your value specified in this property.

If the StandardExitValues parameter in the [FaultHandling] section of the JADE initialization file is set to false, any exit code value that you specify in this property is returned, within any limitations imposed by Microsoft Windows.

Conversely, if the StandardExitValues parameter is set to true, your user-supplied value must be in the range zero (0) through 127, inclusive. If it is outside this range, it is reset to 63. As values in the range 32 through 63, inclusive, are for your use as exit codes, JADE code will not remap JADE error numbers into this range.

As the userExitCode property applies to the JADE node, any JADE application can set this value. Cooperation between applications wanting to set this attribute may therefore be required.