SUSPEND - Suspend task

General

Application area:	Contingency processing; see "Contingency processes" STXIT processing; see "STXIT procedure with contingency processing" Event control; see "Eventing"
Macro type:	Type S, MF format 1: standard/E/L form; see "S-type macros"

Macro description

The SUSPEND macro places the calling basic task or contingency process in a wait state until a (STXIT) contingency process starts.
Caution: If no (STXIT) contingency process is started, the process issuing SUSPEND remains in the wait state.

If SUSPEND is used in conjunction with event control (e.g. asynchronous SOLSIG followed by SUSPEND macro), the user is responsible for ensuring that there is also a POSSIG signal so that the wait state can be terminated with the aid of the contingency process thus started.

Macro format and description of operands

SUSPEND

[MF=L / E]

MF=
For a general description of the MF operand, its operand values and any subsequent operands (e.g. for a prefix), see section “S-type macros”. The valid MF values are given at the start of the macro description under “Macro type” and are included in the macro format.

Return information and error flags

R15:

+---------------+
|   |   |   |   |
|b|b| | | | |a|a|
+---------------+

A structured return code (aa=primary return code, bb=secondary return code) relating to the execution of the SUSPEND macro is transferred in register R15.

X'aa'	X'bb'	Meaning
X'00'	X'00'	Calling task suspended.
X'04'	X'04'	Macro permitted only in TU programs. No action.
X'10'	X'04'	Invalid operands entered. No action.