friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QSPCHGOQ.htm

641 lines
16 KiB
HTML
Raw Blame History

<!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 Output Queue (QSPCHGOQ) 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. -->
<!-- Print 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 Edited by Kersten Oct 2001 -->
<!--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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Change Output Queue (QSPCHGOQ) API</h2>
<div class="box" style="width: 60%;">
<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%">Qualified output queue name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Changes</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</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: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Output Queue (QSPCHGOQ) API changes the following attributes of
the specified output queue:</p>
<ul>
<li>User-defined options</li>
<li>Qualified user-defined object name and type</li>
<li>Qualified user driver program name</li>
<li>Qualified user data transform program name</li>
<li>User-defined data</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Output Queue Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Output Queue Authority</em></dt>
<dd>The caller needs one of the following authorities:
<ul>
<li>*OBJMGT, *READ, *ADD, and *DLT authority to the output queue if the output queue authority to check is data authority (AUTCHK(*DTAAUT).</li>
<li>Owner of the output queue if the output queue authority to check is owner (AUTCHK(*OWNER)).</li>
<li>Job control special authority (*JOBCTL) if the output queue is operator
controlled (OPRCTL(*YES)).</li>
<li>Spool control special authority (*SPLCTL).</li>
</ul>
</dd>
<dt><em>Output Queue Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified output queue name</strong></dt>
<dd>INPUT;CHAR(20)
<p>The name of the output queue for which information is changed. The first 10
characters contain the output queue name and the second 10 characters contain
the name of the library in which the output queue resides.</p>
<p>The following special values are supported for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list used to locate the output queue.</td>
</tr>
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The current library for the job is used to locate the output
queue.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Changes</strong></dt>
<dd>INPUT; CHAR(*)
<p>The changes to be made to the specified output queue. The information must
be in the following format:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>Number of variable length records</em></td>
<td valign="top">BINARY(4)</td>
</tr>
<tr>
<td valign="top"></td>
<td valign="top">Total number of all of the variable length records.</td>
</tr>
<tr>
<td valign="top"><em>Variable length records</em></td>
<td valign="top">Each variable length record contains a keyword plus its
associated new value. Refer to <a href="#HDRFVLRJ">Format of the Variable
Length Record</a> for the structure of this field.</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="HDRFVLRJ">Format of the Variable Length Record</a></h3>
<p>The following table shows the field structure of the variable length record.
For more detail about the fields in the following table, see <a href=
"#HDRFDXYZ">Field Descriptions</a>.</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%">Length of variable length record</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Key identifier</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of new value</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">New value</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRVALKEYX">Valid Keys</a></h3>
<table border cellpadding="3">
<tr>
<th align="left" valign="top">Key</th>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Field</th>
</tr>
<tr>
<td align="left" valign="top" width="20%">201</td>
<td align="left" valign="top" width="25%">CHAR(*)</td>
<td align="left" valign="top" width="55%">User-defined options</td>
</tr>
<tr>
<td align="left" valign="top">202</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Qualified user-defined object name and type</td>
</tr>
<tr>
<td align="left" valign="top">203</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Qualified user driver program name</td>
</tr>
<tr>
<td align="left" valign="top">204</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Qualified user data transform program name</td>
</tr>
<tr>
<td align="left" valign="top">205</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">User-defined data</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFDXYZ">Field Descriptions</a></h3>
<p><strong>Key identifier.</strong> The key value associated with the attribute
to be changed. Only specific attributes of the output queue can change. Refer
to <a href="#HDRVALKEYX">Valid Keys</a> for a list of valid keys.</p>
<p><strong>Length of new value.</strong> The length of the new value to be
assigned to the attribute.</p>
<p><strong>Length of variable length record.</strong> The length of the
record.</p>
<p><strong>New value.</strong> The value to which a specific attribute is to be
set.</p>
<p><strong>Qualified user data transform program name.</strong> The qualified
transform program name has two parts (each part is CHAR(10)):</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>User data transform program name</em></td>
<td valign="top">The name of the user-specified data transform program that is
used by the driver program.
<p>The following values are supported:</p>
<table cellpadding="5">
<tr>
<td valign="top"><em>*NONE</em></td>
<td valign="top">No data transform program is specified.</td>
</tr>
<tr>
<td valign="top"><em>Data transform program name</em></td>
<td valign="top">The name of the data transform program.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td valign="top"><em>Data transform program library name</em></td>
<td valign="top">The name of the library that contains the data transform
program. The following special values are supported for the library name:<br>
<br>
<table cellpadding="5">
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list used to locate the data transform
program.</td>
</tr>
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The current library for the job is used to locate the data
transform program.</td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<p><strong>Qualified user-defined object name and type.</strong> The qualified
user-defined object name and type has three parts (each part is CHAR(10)):</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>User-defined object name</em></td>
<td valign="top">The name of the user-defined object that is used by user
applications or user-specified programs that process spooled files.<br>
The following values are supported:<br>
<br>
<table cellpadding="5">
<tr>
<td valign="top"><em>*NONE</em></td>
<td valign="top">No user-defined object is specified.</td>
</tr>
<tr>
<td valign="top"><em>User-defined object name</em></td>
<td valign="top">The name of the object defined by the user.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td valign="top"><em>User-defined object library name</em></td>
<td valign="top">The name of the library that contains the user-defined
object.<br>
The following special values are supported for the library name:<br>
<br>
<table cellpadding="5">
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list used to locate the user-defined object.</td>
</tr>
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The current library for the job is used to locate the
user-defined object.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td valign="top"><em>User object type</em></td>
<td valign="top">The type of the user-defined object.<br>
The following values are supported:<br>
<br>
<table cellpadding="5">
<tr>
<td valign="top"><em>User object type</em></td>
<td valign="top">The user object type can be:<br>
<br>
Data area (*DTAARA)<br>
Data queue (*DTAQ)<br>
File (*FILE)<br>
PSF configuration object (*PSFCFG)<br>
User index (*USRIDX)<br>
User queue (*USRQ)<br>
User space (*USRSPC)</td>
</tr>
</table>
</td>
</tr>
</table>
<p><strong>Note:</strong> The value must be blanks when the name of the
user-defined object is *NONE</p>
<p><strong>Qualified user driver program.</strong> The qualified user driver
program name has two parts (each part is CHAR(10)):</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>User driver program name</em></td>
<td valign="top">The name of the user-specified driver program that is used to
process the spooled files on the output queue.<br>
<br>
<table cellpadding="5">
<tr>
<td valign="top"><em>*NONE</em></td>
<td valign="top">No user driver program is specified.</td>
</tr>
<tr>
<td valign="top"><em>User driver program name</em></td>
<td valign="top">The name of the user-specified driver program.</td>
</tr>
</table>
<br>
The following values are supported:</td>
</tr>
<tr>
<td valign="top"><em>User driver program library name</em></td>
<td valign="top">The name of the library that contains the user driver program.
<p>The following special values are supported for the library name:</p>
<table cellpadding="5">
<tr>
<td valign="top"><em>*LIBL</em></td>
<td valign="top">The library list used to locate the user driver program.</td>
</tr>
<tr>
<td valign="top"><em>*CURLIB</em></td>
<td valign="top">The current library for the job is used to locate the user
driver program.</td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<p><strong>User-defined data.</strong> Data defined by the user to be used by
user applications or user-specified programs that process spooled files.</p>
<p>The following table shows the layout of the user-defined extended data
field:</p>
<table border cellpadding="3">
<tr>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Field</th>
</tr>
<tr>
<td align="left" valign="top" nowrap width="20%">BINARY(4)</td>
<td align="left" valign="top" width="80%">Length of user-defined data.
<p>The values supported range from 0 through 5000.</p>
</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">User-defined data</td>
</tr>
</table>
<p><strong>User-defined options.</strong> The following table shows the layout
of the user-defined options field.</p>
<p><strong>Note:</strong> To change the user-defined options to *NONE, set the
number of user-defined options to 0.<br>
<br>
</p>
<table border cellpadding="3">
<tr>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Field</th>
</tr>
<tr>
<td align="left" valign="top" nowrap width="20%">BINARY(4)</td>
<td align="left" valign="top" width="80%">Number of user-defined options
<p>The number of user-defined options for the output queue. Specify a number
from 0 to 4.</p>
</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">User-defined options array
<p>An array of options defined by the user to be used by user applications or
user-specified programs that process spooled files. Each option is defined as
CHAR(10).</p>
</td>
</tr>
</table>
<br>
<h3>Error Messages</h3>
<table 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">CPF2207 E</td>
<td width="85%" valign="top">Not authorized to use object &amp;1 in library
&amp;3 type *&amp;2.</td>
</tr>
<tr>
<td valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C4D E</td>
<td valign="top">Length &amp;1 for key &amp;2 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C81 E</td>
<td valign="top">Value for key &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C82 E</td>
<td valign="top">Key &amp;1 not valid for API &amp;2.</td>
</tr>
<tr>
<td valign="top">CPF3319 E</td>
<td valign="top">Cannot change parameters specified. A writer is active to
output queue &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF3330 E</td>
<td valign="top">Necessary resource not available.</td>
</tr>
<tr>
<td valign="top">CPF34B1 E</td>
<td valign="top">Output queue &amp;1 in library &amp;2 not found.</td>
</tr>
<tr>
<td valign="top">CPF34D9 E</td>
<td valign="top">User defined object type &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF34DA E</td>
<td valign="top">Output queue &amp;1 in &amp;2 not changed due to errors.</td>
</tr>
<tr>
<td valign="top">CPF8122 E</td>
<td valign="top">&amp;8 damage on library &amp;4.</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>
<hr>
API introduced: V3R7
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"print1.htm">Print APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink