SPFLite

num-var = Halt([rc-num,] [msg-str] [,msg-str] ...)

Operands:

[rc-num]

this optional operand provides the numeric return code you wish SPFLite to use for the success of this macro invocation. If the operand is omitted, then 0 (zero) is assumed.

The conventions (and allowable values) for these return codes are:

RC=0 for success

RC=8 when a failure occurs

There are predefined symbols for these values. OK is the same as 0;  and FAIL is the same as 8.

To avoid issues with future versions of SPFLite, only the values 0, and 8 (or their symbolic equivalents of OK, and FAIL) should be used as return code values.

msg-str

a string containing the text of the message to be issued. When multiple strings are provided as operands, they will be concatenated together with a single blank between the operands.

Returns:

Nothing is returned. The macro is terminated by this function and control returned to normal SPFLite operation.

Special Notes:

If RC is not zero,  SPFLite will prefix the text with RC=8: 

Because the RC operand is optional, simple success messages can be issued with only the text string operand. For example:

Halt("Normal completion")

is functionally equivalent to:

Halt(OK, "Normal completion")