Change Job Interrupt Status (QWCCJITP) API
Required Parameter Group:
1 | Current job interrupt status | Output | Char(1) |
2 | New job interrupt status | Input | Char(1) |
3 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: Conditional, see Usage Notes.
The Change Job Interrupt Status (QWCCJITP) API will retrieve and optionally modify the job interrupt status of the current job. For additional information, see Usage Notes.
Authorities and Locks
None
Required Parameter Group
- Current job interrupt status
- OUTPUT; CHAR(1)
The variable that is used to return the current job interrupt status. The possible values are:
0 The current job is uninterruptible. 1 The current job is interruptible.
- New job interrupt status
- INPUT; CHAR(1)
The variable that is used to specify the new job interrupt status. The possible values are:
0 The current job is uninterruptible. 1 The current job is interruptible. * The job interrupt status is not modified.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Usage Notes
Considerations for Thread Safety
The conditions under which this API is threadsafe are as follows:
- Changing the job interrupt status of the current job from the primary thread of the job.
The conditions under which this API is not threadsafe are as follows:
- Changing the job interrupt status of the current job from a secondary
thread of the job. Invocations of this API from secondary threads run
asynchronous to interruptions occurring in the primary thread and can interfere
with the interruption control being manipulated by the primary thread.
- When multiple threads in the same job are concurrently retrieving and optionally modifying the job interrupt status, the results can be unpredictable.
Considerations for Job Interruptibility
For a job to be interrupted, the system must allow jobs to be interrupted. The Allow jobs to be interrupted (QALWJOBITP) system value determines if the system will allow jobs to be interrupted. For all new jobs becoming active, the QALWJOBITP system value is used to determine the initial value for the job interrupt status for that job.
The Change Job Interrupt Status (QWCCJITP) API will retrieve and optionally modify the job interrupt status of the current job. If the job is currently uninterruptible, any program called by the Call Job Interrupt Program (QWCJBITP) API will not be able to run in this job. When the job is modified to be interruptible, programs called by the QWCJBITP API will be able to interrupt and run in this job.
Error Messages
Message ID | Error Message Text |
---|---|
CPF24B4 E | Severe error while addressing parameter list. |
CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
CPF3C3C E | Value for parameter &1 not valid. |
CPF3CF1 E | Error code parameter not valid. |
CPF3CF2 E | Error(s) occurred during running of &1 API. |
CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V5R4