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

324 lines
8.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 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 Current Job (QWCCCJOB) 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. -->
<!-- WM SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Nov 2001 by v2cdijab -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Change Current Job (QWCCCJOB) API</h2>
<div class="box" style="width: 80%;">
<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%">Changed job information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</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: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Current Job (QWCCCJOB) API lets you change information for the
current job. The user can change the Cancel or the Exit keys.</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Changed job information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information for the job that you want to change. The information must be
in the following format:</p>
<dl>
<dt><em>Number of variable length records</em></dt>
<dd>BINARY(4)</dd>
<dd>Total number of all of the variable length records.<br>
<br>
</dd>
<dt><em>Variable length records</em></dt>
<dd>The fields of the job to change and the data used for the change. For the
specific format of the variable length record, see <a href="#HDRVARLRWM">Format
for Variable Length Record</a>.</dd>
</dl>
<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="HDRVARLRWM">Format for Variable Length Record</a></h3>
<p>The following table defines the format for the variable length records.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Key identifier</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of key data</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Key data</td>
</tr>
</table>
<p>If the length of the data is longer than the key identifier's data length,
the data will be truncated at the right. No message will be issued.</p>
<p>If the length of the data is smaller than the key identifier's data length,
the data will be padded with blanks at the right. No message will be
issued.</p>
<p>It is not an error to specify a key more than once. If duplicate keys are
specified, the last specified value for that key is used.</p>
<p>Each variable length record must be 4-byte aligned. If not, unpredictable
results may occur.</p>
<br>
<h3>Field Descriptions</h3>
<p><strong>Key data.</strong> The data used to change a specific field of the
job.</p>
<p><strong>Key identifier.</strong> The field of the job to change. Only
specific fields of the job can be changed. See <a href="#HDRKEYFLWM">Key
Identifiers</a> for the list of valid keys.</p>
<p><strong>Length of key data.</strong> The length of the data used to change a
specific field of the job.</p>
<br>
<h3><a name="HDRKEYFLWM">Key Identifiers</a></h3>
<p>The following table lists the valid keys for the key identifier area of the
variable length record.</p>
<table border width="80%">
<tr>
<th align="center" valign="top">Key ID</th>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Field Description</th>
</tr>
<tr>
<td align="center" valign="top" width="15%">1</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="65%">Exit key</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Cancel key</td>
</tr>
</table>
<br>
<br>
<h3>Key Identifier Descriptions</h3>
<p><strong>Exit key.</strong> Whether the Exit key is set as pressed for the
job. It must have a value of 0 or 1.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The Exit key was not pressed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The Exit key was pressed.</td>
</tr>
</table>
<p><strong>Note:</strong> The application or command that was called before
this API determines how the key is set.</p>
<p><strong>Cancel key.</strong> Whether the Cancel key is set as pressed for
the job. It must have a value of 0 or 1.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The Cancel key was not pressed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The Cancel key was pressed.</td>
</tr>
</table>
<p><strong>Note:</strong> The application or command that was called before
this API determines how the key is set.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF1863 E</td>
<td align="left" valign="top">Length of value not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1867 E</td>
<td align="left" valign="top">Value &amp;1 in list not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1868 E</td>
<td align="left" valign="top">Value &amp;1 for number of records not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2199 E</td>
<td align="left" valign="top">&amp;2 not valid for key &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top">Top</a> |
<a href="wm1.htm">Work Management APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>