443 lines
12 KiB
HTML
443 lines
12 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 User Space Attributes (QUSCUSAT) 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. -->
|
|
<!-- QUSCUSAT SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
|
|
<!-- RCHVMW2 on 7 Oct 1998 at 17:04:40 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- Edited by Kersten Jan 02 -->
|
|
<!--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 User Space Attributes (QUSCUSAT) API</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<br>
|
|
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%">Returned library name</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Qualified user space name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Attributes to change</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Change User Space Attributes (QUSCUSAT) API changes the attributes of a
|
|
user space object. This API can be used to:</p>
|
|
|
|
<ul>
|
|
<li>Extend or truncate a user space</li>
|
|
|
|
<li>Mark or unmark the user space as automatically extendible by the
|
|
system</li>
|
|
|
|
<li>Change the initial value to which future extensions of the user space will
|
|
be set</li>
|
|
|
|
<li>Change the number of pages transferred between main storage and auxiliary
|
|
storage</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>User Space Authority</em></dt>
|
|
|
|
<dd>*CHANGE, *OBJMGT</dd>
|
|
|
|
<dt><em>User Space Lock</em></dt>
|
|
|
|
<dd>*EXCL</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Returned library name</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(10)
|
|
|
|
<p>The name of the library that contains the changed user space object. If the
|
|
space attributes are successfully changed, the name of the library in which the
|
|
user space was found is returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The first 10 characters contain the user space name, and the second 10
|
|
characters contain the name of the library where the user space is located. The
|
|
special values supported for the library name are *LIBL and *CURLIB.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Attributes to change</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The attributes of the user space object that you want to change.</p>
|
|
|
|
<p>The information must be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Number of variable length records</em></td>
|
|
<td align="left" valign="top">BINARY(4)
|
|
|
|
<p>The total number of all of the variable length records.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Variable length records</em></td>
|
|
<td align="left" valign="top">The attributes of the user space to change and
|
|
the data used for the change. For the specific format of the variable length
|
|
record, refer to <a href="#HDRSAT1">Format for Variable Length
|
|
Records</a>.</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="HDRSAT1">Format for Variable Length Records</a></h3>
|
|
|
|
<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</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 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">Data</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p>If you specify a length of data that is longer than the key field's defined
|
|
data length, the data will be truncated at the right. No error message will be
|
|
returned.</p>
|
|
|
|
<p>If you specify a length of data that is shorter than the key field's defined
|
|
data length, an error message will be returned.</p>
|
|
|
|
<p>You may 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><a name="HDRCHGOBJ">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Data.</strong> The value to which a specific user space attribute is
|
|
to be changed. All values are validity checked.</p>
|
|
|
|
<p><strong>Key.</strong> The user space attribute to be changed. Only specific
|
|
attributes can be changed. Refer to <a href="#HDRKEYSAT">Keys</a> for more
|
|
information.</p>
|
|
|
|
<p><strong>Length of data.</strong> The length of the new user space attribute
|
|
value. The length of data field is used to get addressability to the next
|
|
attribute record.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRKEYSAT">Keys</a></h3>
|
|
|
|
<p>The following table lists the keys that can be used in the attribute
|
|
record.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="left" valign="bottom">Key</th>
|
|
<th align="left" valign="bottom">Type</th>
|
|
<th align="left" valign="bottom">Attribute</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="bottom">1</td>
|
|
<td align="left" valign="bottom">BINARY(4)</td>
|
|
<td align="left" valign="bottom">Space size</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="bottom">2</td>
|
|
<td align="left" valign="bottom">CHAR(1)</td>
|
|
<td align="left" valign="bottom">Initial value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="bottom">3</td>
|
|
<td align="left" valign="bottom">CHAR(1)</td>
|
|
<td align="left" valign="bottom">Automatic extendibility</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="bottom">4</td>
|
|
<td align="left" valign="bottom">BINARY(4)</td>
|
|
<td align="left" valign="bottom">Transfer size request</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRKEYLI">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Automatic extendibility.</strong> Whether or not the user space is
|
|
automatically extended by the system when the end of the space is
|
|
encountered.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The user space is not automatically
|
|
extendible.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user space is automatically extendible.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p><strong>Initial value.</strong> The initial value to which future extensions
|
|
of the user space will be set. You will achieve the best performance if you set
|
|
this byte to hexadecimal zeros (X'00').</p>
|
|
|
|
<p><strong>Space size.</strong> The size in bytes of the user space object. If
|
|
this value is smaller than the current size of the space, the user space is
|
|
truncated. If it is larger, the space is extended.</p>
|
|
|
|
<p><strong>Transfer size request.</strong> The number of pages to be
|
|
transferred between main storage and auxiliary storage. This is only a request,
|
|
as the machine may use a value of its choice in some circumstances. Allowable
|
|
values range between 0 and 32 pages. A value of 0 is an indication that the
|
|
machine should use the default transfer size for the user space. A larger
|
|
transfer size may allow for better performance of applications processing the
|
|
user space.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table 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 width="15%" valign="top">CPF24B4 E</td>
|
|
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C4B E</td>
|
|
<td align="left" valign="top">Value not valid for field &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C4C E</td>
|
|
<td align="left" valign="top">Value not valid for field &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C4D E</td>
|
|
<td align="left" valign="top">Length &1 for key &2 not valid.</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">CPF8100 E</td>
|
|
<td align="left" valign="top">All CPF81xx messages could be returned. xx is
|
|
from 01 to FF.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9801 E</td>
|
|
<td align="left" valign="top">Object &2 in library &3 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9803 E</td>
|
|
<td align="left" valign="top">Cannot allocate object &2 in library
|
|
&3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9807 E</td>
|
|
<td align="left" valign="top">One or more libraries in library list
|
|
deleted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9808 E</td>
|
|
<td align="left" valign="top">Cannot allocate one or more libraries on library
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9810 E</td>
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9820 E</td>
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9830 E</td>
|
|
<td align="left" valign="top">Cannot assign library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9838 E</td>
|
|
<td align="left" valign="top">User profile storage limit exceeded.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V2R3
|
|
|
|
<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=
|
|
"obj1.htm">Object API categories</a> | <a href="aplist.htm">API by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|
|
|