ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwccjitp.htm

238 lines
6.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Change Job Interrupt Status (QWCCJITP) API</title>
<!-- Begin Header Records -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2><img src="delta.gif" alt="Start of change">Change Job Interrupt Status (QWCCJITP) API</h2>
<div class="box" style="width: 85%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Current job interrupt status</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">New job interrupt status</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Error Code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Conditional, see <a href="#unotes">Usage Notes</a>.
<br>
</div>
<p>
The Change Job Interrupt Status (QWCCJITP) API will retrieve and optionally modify the job interrupt status of the current job. For additional information, see <a href="#unotes">Usage Notes</a>.
</p>
<br>
<h3>Authorities and Locks</h3>
<p>None</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Current job interrupt status</strong></dt>
<dd>OUTPUT; CHAR(1)
<p>
The variable that is used to return the current job interrupt status. The possible values are:
</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The current job is uninterruptible.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The current job is interruptible.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>New job interrupt status</strong></dt>
<dd>INPUT; CHAR(1)
<p>
The variable that is used to specify the new job interrupt status. The possible values are:
</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The current job is uninterruptible.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The current job is interruptible.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*</em></td>
<td align="left" valign="top">The job interrupt status is not modified.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>
The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.
</p>
</dd>
</dl>
<br>
<h3><a name="unotes">Usage Notes</a></h3>
<p><strong>Considerations for Thread Safety</strong></p>
<p>
The conditions under which this API is threadsafe are as follows:
</p>
<ul>
<li>Changing the job interrupt status of the current job from the primary thread of the job.
</ul>
<p>
The conditions under which this API is not threadsafe are as follows:
</p>
<ul>
<li>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.
<br>
<br>
</li>
<li>When multiple threads in the same job are concurrently retrieving and
optionally modifying the job interrupt status, the results can be
unpredictable.</li>
</ul>
<p><strong>Considerations for Job Interruptibility</strong></p>
<p>
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.
</p>
<p>
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
<a href="./qwcjbitp.htm">Call Job Interrupt Program (QWCJBITP) API</a>
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.
</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3C36 E</td>
<td valign="top">Number of parameters, &amp;1, entered for this API was not
valid.</td>
</tr>
<tr>
<td valign="top">CPF3C3C E</td>
<td valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<br>
<img src="deltaend.gif" alt="End of change">
<hr>
API introduced: V5R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> |
<a href="wm1.htm">Work Management APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>