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

297 lines
8.0 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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>Set Profile Exit Programs (QWTSETPX) 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>Set Profile Exit Programs (QWTSETPX) 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="40%">Number of entries</td>
<td align="left" valign="top" width="15%">Input</td>
<td align="left" valign="top" width="35%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Exit program flags</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Array(*) of Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">User ID</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</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: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Set Profile Exit Programs (QWTSETPX) API sets for the specified user ID
the profile exit programs to call based on the format value. The value ATTN0100
sets the exit flags for attention key processing. The value SREQ0100 sets the
flags for system request processing. For the specified user ID, each of the
eight exit program flags may be set to the following:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No, do not call this exit program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Yes, call this exit program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Same, do not change the value.</td>
</tr>
</table>
<p>If all the values are set to 0 (No), no new actions are taken during the
attention key processing or system request processing.</p>
<p>Each exit program flag that is set to 1 (Yes) by this API corresponds to the
exit program number of the exit programs that are registered in the
registration facility for the QIBM_QWT_PREATTNPGMS exit point or the
QIBM_QWT_SYSREQPGMS exit point.</p>
<p>When attention key processing is activated by a job that is running under
the specified user ID, only the exit programs that have a 1 (Yes) for that exit
program flag are called.</p>
<p>When system request key processing is activated by a job that is running
under the specified user ID, only the exit programs that have a 1 (Yes) for
that exit program flag are called.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Number of entries</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of exit program flags that are being passed in. The maximum
number of flags is 8, and the minimum number of flags is 1.</p>
</dd>
<dt><strong>Exit program flags</strong></dt>
<dd>INPUT; ARRAY(*) of BINARY(4)
<p>An array of a number of elements. The number of array elements must match
the number of entries. The valid values for the array elements are as
follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No, do not call this exit program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Yes, call this exit program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Do not change the value.</td>
</tr>
</table>
<p>The first element of the array corresponds to exit program number one for
the exit point that is in the registration facility. The second array element
corresponds to exit program number two and so on.</p>
</dd>
<dt><strong>Format</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format that is to be updated. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>ATTN0100</em></td>
<td align="left" valign="top">The preattention program processing flags are to
be updated.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SREQ0100</em></td>
<td align="left" valign="top">The presystem request program processing flags
are to be updated.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>User ID</strong></dt>
<dd>INPUT; CHAR(10)
<p>The user ID name being updated. Valid values are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">The user ID of the job that is currently running
is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>User ID name</em></td>
<td align="left" valign="top">The 10-character name that is entered is
used.</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>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">CPF1666 E</td>
<td align="left" valign="top" width="85%">Number of entries not in valid
range.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2204 E</td>
<td align="left" valign="top">User profile &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2213 E</td>
<td align="left" valign="top">Not able to allocate user profile &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2217 E</td>
<td align="left" valign="top">Not authorized to user profile &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: V3R6
<hr>
<center>
<table 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>
</center>
</body>
</html>