991 lines
30 KiB
HTML
991 lines
30 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 Object Description (QLICOBJD) 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. -->
|
|
<!-- QLICOBJD SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
|
|
<!-- RCHVMW2 on 15 Oct 1998 at 14:53:39 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- File cleanup completed Feb 2002 by v2cdijab -->
|
|
<!-- Updates from System API Programming book phase-out, July 2002 by JET -->
|
|
<!-- 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 Object Description (QLICOBJD) 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">Object and library 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">Object type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Changed object information</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Change Object
|
|
Description (QLICOBJD) API lets you change object information for a specific
|
|
object similar to the Change Object Description (CHGOBJD) command. Unlike the
|
|
CHGOBJD command, this can be used on all external object types. This API
|
|
supports changing more parts of the object descriptive information than are
|
|
supported using the CHGOBJD command.</p>
|
|
|
|
<p><img src="delta.gif" alt="Start of change"> Before any change other
|
|
than to the text or the days used count and reset date is made with this API,
|
|
the allow change by program field for the object is checked. If this API cannot
|
|
be used to change the object, message CPF219B is issued.</p>
|
|
|
|
<p>When an object has been successfully updated by the API, the changed by
|
|
program field is updated. In addition, the change date and time stamp
|
|
(date and time the object was changed) field is also updated unless you also
|
|
specify that the change date and time stamp field is not to be updated. You
|
|
can only specify that the change date and time stamp field is not to be updated
|
|
when the only field to be updated is the last used date field.</p>
|
|
|
|
<p>If the object being changed is currently journaled, a journal entry (type ZB)
|
|
is deposited in the journal to record the change.</p>
|
|
|
|
<p><strong>Note:</strong> For additional information regarding journaling, see
|
|
<a href="../rzaki/rzakikickoff.htm">Journal management</a>. <img src="deltaend.gif"
|
|
alt="End of change"> </p>
|
|
|
|
<br>
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Library Authority</em></dt>
|
|
|
|
<dd>*EXECUTE</dd>
|
|
|
|
<dt><em>Non-*FILE Object Authority</em></dt>
|
|
|
|
<dd>*OBJMGT</dd>
|
|
|
|
<dt><em>*FILE Object Authority</em></dt>
|
|
|
|
<dd>*OBJOPR and *OBJMGT</dd>
|
|
|
|
<dt><em>Object Lock</em></dt>
|
|
|
|
<dd>*EXCLRD</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 object. If *CURLIB, *LIBL,
|
|
or a name is specified for the library name in the object and library name
|
|
parameter, the value returned is the name of the library where the object was
|
|
found. If an error occurred while the API was accessing the object, blanks are
|
|
returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Object and library name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>The object for which you want to change information and the library in which
|
|
it is located. The first 10 characters contain the object name, and the second
|
|
10 characters contain the library name. You can use these special values for
|
|
the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">The job's library list</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Object type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The type of object for which you want to change the information. You can
|
|
only specify specific external object types. An asterisk (*) must precede the
|
|
object type. For a complete list of the available object types, see the
|
|
<img src="delta.gif" alt="Start of change">
|
|
<a href="../rbam6/rbam6objecttypes.htm">External object
|
|
types</a><img src="deltaend.gif" alt="End of change"> information.</p></dd>
|
|
|
|
<dt><strong>Changed object information</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The information for the object that you want to change. The information must
|
|
be in the following format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Number of variable length records</em></td>
|
|
<td align="left" valign="top">BINARY(4)<br>
|
|
Total number of all of the variable length records. If the value of this field
|
|
is less than 0, an error message is returned. <img src="delta.gif"
|
|
alt="Start of change"> It is not an error if this field is 0. If it is 0,
|
|
the API will make no changes to the object's description.
|
|
<img src="deltaend.gif" alt="End of change"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Variable length records</em></td>
|
|
<td align="left" valign="top">The fields of the object's description to change
|
|
and the data used for the change. For the specific format of the variable
|
|
length record, see <a href="#HDRVARLRC">Format for Variable Length
|
|
Record</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="HDRVARLRC">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</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>
|
|
|
|
<p>If the length of the data is longer than the related field'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 related field'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><a name="HDRCHGOBJ1">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Data.</strong> The data used to change a specific field of the
|
|
object description. Validity checking is done on the values specified for the
|
|
following keys to verify that they are '0' or '1'.</p>
|
|
|
|
<ul>
|
|
<li>Allow change by program</li>
|
|
|
|
<li>Days used count and reset date</li>
|
|
|
|
<li>Last used date<br>
|
|
</li>
|
|
|
|
<li>Change date and time stamp</li>
|
|
</ul>
|
|
|
|
<p>The data specified for other keys is not validity checked.</p>
|
|
|
|
<p><strong>Key.</strong> Identifies a field of the object's description to
|
|
change. Only specific fields of the object's description can be changed. See <a
|
|
href="#HDRKEYFD1">Keys</a> for the list of valid keys.</p>
|
|
|
|
<p><strong>Length of data.</strong> The length of the data used to change a
|
|
specific field of the object's description. If the value of this field is 0 or
|
|
negative, an error message is returned.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRKEYFD1">Keys</a></h3>
|
|
|
|
<p>The following table lists the valid keys for the key field of the variable
|
|
length record.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="top">Key</th>
|
|
<th align="left" valign="top">Type</th>
|
|
<th align="left" valign="top">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">1</td>
|
|
<td align="left" valign="top" width="25%">CHAR(30)</td>
|
|
<td align="left" valign="top" width="60%">Source file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Source file date/time</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Compiler</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(8)</td>
|
|
<td align="left" valign="top">Object control level</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Licensed program</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Program temporary fix (PTF)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Authorized program analysis report (APAR)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Allow change by program</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User-defined attribute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Text</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Days used count and reset date</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Product option load ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">13</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Product option ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Component ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">15</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Last used date</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Change date and time stamp</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Member's days used count and reset date</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRKEYLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Allow change by program.</strong> <img src="delta.gif"
|
|
alt="Start of change"> Whether to allow users to make changes to the object's
|
|
description other than to the text or the days used count and reset date with
|
|
this API. It must have a value of '0' or '1'.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Changes other than to the text or the days used count
|
|
and reset date are not allowed with this API. Once this field has been changed to
|
|
'0', this API cannot be used to make any further changes to the object's description
|
|
other than to the text or the days used count and reset date.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">Changes are allowed with this API. This API can be
|
|
used to make all changes to the object's description.
|
|
<img src="deltaend.gif" alt="End of change"> </td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Authorized program analysis report (APAR).</strong> The authorized
|
|
program analysis report identification that caused this object to be patched.
|
|
IBM APARs have an uppercase alphabetic character followed by 5 decimal numbers.
|
|
If you want to conform with the system, this format should be followed.</p>
|
|
|
|
<p><strong>Change date and time stamp.</strong> The date and time the object
|
|
was last changed. This is useful if you want to update an object's change
|
|
date and time stamp and do not want to update any other fields or if you want
|
|
to update the last used date (key 15) and do not want to update the change
|
|
date and time stamp.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">The change date and time stamp is not
|
|
updated.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">The change date and time stamp is updated to the
|
|
current system date and time.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This key cannot be specified with any other key except key 15 (last used date). If it is, message CPF21A6
|
|
is issued.</p>
|
|
|
|
<p><strong>Note:</strong> For database files, the last change date/time is
|
|
updated for all members in the file and the file itself.</p>
|
|
|
|
<p><strong>Compiler.</strong> The name, version level, release level, and
|
|
modification level of the compiler. Objects created with IBM products will have
|
|
the licensed program name of the compiler in the compiler name field and a
|
|
version field in the VxRxMy format where x must be 0-9 and y must be 0-9 or
|
|
A-Z. If you want to conform with the system, this format should be
|
|
followed.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Compiler name</em></td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Version</em></td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Component ID.</strong> The product administrator owns this field. It
|
|
can be used to track information about objects, such as object size, at a lower
|
|
level than the product option ID.</p>
|
|
|
|
<p><strong>Days used count and reset date.</strong> This key is used to:</p>
|
|
|
|
<ul>
|
|
<li>Reset the number of days an object has been used on the system.</li>
|
|
|
|
<li>Update the date the days used count was last reset to 0.</li>
|
|
</ul>
|
|
|
|
<p>It must have a value of '0' or '1'.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">Neither the days used count nor the reset date on
|
|
the Display Object Description panel is updated.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">The days used count is set to 0. The reset date
|
|
on the Display Object Description panel is updated to the current system
|
|
date.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This key (11) and
|
|
the last used date (key 15) cannot both be specified with a value of '1'. These keys
|
|
are incompatible because key 11 will change the days used count to 0 and key 15 will
|
|
increase the days used count. If both keys 11 and 15 are specified with a value of
|
|
'1', error message CPF21A1 is issued.
|
|
</p>
|
|
|
|
<p>This key (11) with a value of '1'
|
|
and the member's days used count (key 17) cannot both be specified.
|
|
These keys are incompatible because key 11 will change the days used count for all
|
|
members in a file and key 17 will change the days used count for a single member. If
|
|
key 11 with a value of '1' and key 17 are both specified, error message CPF21A1 is
|
|
issued.</p>
|
|
|
|
<p>This key cannot be specified for *DOC object types or when object usage
|
|
information is not updated for
|
|
the specified object type.
|
|
Object usage information is not updated for all object types. For more details
|
|
on usage information, see the <img src="delta.gif" alt="Start of change">
|
|
<a href="../rbam6/detob.htm">Detect unused objects on the system</a>
|
|
<img src="deltaend.gif" alt="End of change"> information. Use
|
|
the <img src="delta.gif" alt="Start of change"><a href="../apis/qsetattr.htm">Set
|
|
Attributes</a><img src="deltaend.gif" alt="End of change"> Qp0lSetAttr() API
|
|
to update this field for *DOC object types. If this key is not allowed for an
|
|
object type, error message CPF2131 is issued.</p>
|
|
|
|
<p><strong>Note:</strong> For database files, the days used count reset date
|
|
and the days used count are updated for all members in the file.</p>
|
|
|
|
<p><strong>Last used date.</strong> This key is used to:</p>
|
|
|
|
<ul>
|
|
<li>Update the last used date to the current system date.</li>
|
|
|
|
<li>Increase the days used count.</li>
|
|
</ul>
|
|
|
|
<p>It must have a value of '0' or '1'.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>'0'</em></td>
|
|
<td align="left" valign="top">The last used date is not updated. The days used
|
|
count is not increased.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'1'</em></td>
|
|
<td align="left" valign="top">The last used date is updated to the current
|
|
system date. If this is the first use of the object today (since midnight), the
|
|
days used count is increased.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>This key cannot be specified for *DOC object types or when object usage
|
|
information is not updated for
|
|
the specified object type.
|
|
Object usage information is not updated for all object types. For more details
|
|
on usage information, see the <img src="delta.gif" alt="Start of change">
|
|
<a href="../rbam6/detob.htm">Detect unused objects on the system</a>
|
|
<img src="deltaend.gif" alt="End of change"> information. Use
|
|
the <img src="delta.gif" alt="Start of change"><a href="../apis/qsetattr.htm">Set
|
|
Attributes</a><img src="deltaend.gif" alt="End of change"> Qp0lSetAttr() API
|
|
to update this field for *DOC object types. If this key is not allowed for an
|
|
object type, error message CPF2131 is issued.</p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> For database files, the last used date and number
|
|
of days used count are updated for all members in the file.
|
|
|
|
<p>The last used date cannot be changed for a database file that does not have
|
|
any members. Error message CPF21A2 will be issued.</p>
|
|
</blockquote>
|
|
|
|
<p>This key (15) and the days used
|
|
count (key 11) cannot both be specified with a value of '1'. These keys are
|
|
incompatible because key 11 will change the days used count to 0 and key 15 will
|
|
increase the days used count. If keys 11 and 15 are both specified with a value of
|
|
'1', error message CPF21A1 is issued.</p>
|
|
|
|
<p>This key (15) with a value of '1' and the member's last used date (key 17) cannot
|
|
both be specified. These keys are incompatible because key 15 will increase the days
|
|
used count and key 17 will change the days used count to 0 for a member. If key
|
|
15 with a value of '1' and key 17 are both specified, error message CPF21A1 is
|
|
issued.</p>
|
|
|
|
<p><strong>Licensed program.</strong> The name, version level, release level,
|
|
and modification level of the licensed program. Objects that are a part of an
|
|
IBM licensed program have a valid licensed program name (7 characters
|
|
containing 0-9 and uppercase A-Z). The version is in the VxRxMy format where x
|
|
must be 0-9 and y must be 0-9 or A-Z. If you want to conform with the system,
|
|
this format should be followed.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Licensed program name</em></td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Version</em></td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Member's days used count and reset date.</strong> This key is used to:</p>
|
|
|
|
<ul>
|
|
<li>Reset the number of days a database file member has been used on the
|
|
system.</li>
|
|
|
|
<li>Update the member's date that the days used count was last reset to 0.</li>
|
|
</ul>
|
|
|
|
<p>This field must be a valid 10-character file-member name and must be padded
|
|
with blank characters. No special values are allowed.</p>
|
|
|
|
<p>This key (17) and the days used
|
|
count (key 11) with a value of '1' cannot both be specified. These keys are
|
|
incompatible because key 11 will change the days used count for all members in a file
|
|
and key 17 will change the days used count for a single member. If key 11 with
|
|
a value of '1' and key 17 are both specified, error message CPF21A1 is issued.</p>
|
|
|
|
<p>This key (17) and the last used
|
|
date (key 15) with a value of '1' cannot both be specified. These keys are
|
|
incompatible because key 15 will increase the days used count and key 17 will change
|
|
the days used count to 0 for a member. If key 15 with a value of '1' and key 17
|
|
are both specified, error message CPF21A1 is issued.
|
|
</p>
|
|
|
|
<p>This key can be specified only for an object type of *FILE. If the object is
|
|
not a *FILE object, error message CPF2131 is issued.</p>
|
|
|
|
<p><strong>Note:</strong> This key updates the days used count for a single
|
|
member only. To reset the days used count for all members in a database file,
|
|
specify key 11.</p>
|
|
|
|
<p><strong>Object control level.</strong> The object control level for the
|
|
object. IBM programs will have an 8-character decimal value.</p>
|
|
|
|
<p><strong>Product option ID.</strong> Identifies part of a licensed program
|
|
(product). Products can have multiple options. Objects that are a part of an
|
|
IBM licensed program must be 0000 (*BASE) through 0099. If you want to conform
|
|
with the system, this format should be followed.</p>
|
|
|
|
<p><strong>Product option load ID.</strong> The language identifier associated
|
|
with the object. Objects that are a part of an IBM licensed program must have
|
|
one of the allowed languages in the 29xx format. If you want to conform with
|
|
the system, this format should be followed.</p>
|
|
|
|
<p><strong>Program temporary fix.</strong> The program temporary fix (PTF) that
|
|
resulted in the creation of the object. For IBM objects the first 2 characters
|
|
are a prefix ID, and the remaining 5 characters are the program change ID
|
|
(decimal). The field is blank if the object was not changed because of a PTF.
|
|
If you want to conform with the system, this format should be followed.</p>
|
|
|
|
<p><strong>Source file.</strong>The name of the source file used to create the
|
|
object, the name of the library in which it is located, and the name of the source
|
|
file member.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Source file name</em></td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Library name</em></td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Member name</em></td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>Objects created with IBM products have valid object names for the qualified
|
|
source file name. If you want to conform with the system, this format should be
|
|
followed.</p>
|
|
|
|
<p><strong>Source file date/time.</strong> The date and time
|
|
the member in the source file was last updated. Objects created with IBM
|
|
products will be in the CYYMMDDHHMMSS format:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>C</em></td>
|
|
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
|
|
and 1 indicates years 20<em>xx</em>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>YY</em></td>
|
|
<td align="left" valign="top">Year</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Month</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>DD</em></td>
|
|
<td align="left" valign="top">Day</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>HH</em></td>
|
|
<td align="left" valign="top">Hour</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Minute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>SS</em></td>
|
|
<td align="left" valign="top">Second</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If you want to conform with the system, this format should be followed.</p>
|
|
|
|
<p><strong>Text.</strong> The user-defined text that briefly describes the
|
|
object and its function.</p>
|
|
|
|
<p><strong>User-defined attribute.</strong> An attribute you define. This
|
|
should not be confused with the extended attribute of the object. The extended
|
|
attribute is set by the system when an object is created.</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 align="left" valign="top">CPF21A1 E</td>
|
|
<td align="left" valign="top">Key &1 not allowed with key &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF21A2 E</td>
|
|
<td align="left" valign="top">Last used date for &1 in &2 type *FILE
|
|
cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF21A6 E</td>
|
|
<td align="left" valign="top">Cannot specify key &1 with other specified keys.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2131 E</td>
|
|
<td align="left" valign="top">Key &1 not allowed with object type
|
|
*&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2150 E</td>
|
|
<td align="left" valign="top">Object information function failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2151 E</td>
|
|
<td align="left" valign="top">Operation failed for &2 in &1 type
|
|
*&3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF219B E</td>
|
|
<td align="left" valign="top">Cannot change &1 in &2 type *&3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF219E E</td>
|
|
<td align="left" valign="top">Object type *&1 not valid external object
|
|
type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2199 E</td>
|
|
<td align="left" valign="top">&2 not valid for key &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">CPF2451 E</td>
|
|
<td align="left" valign="top">Message queue &1 is allocated to another
|
|
job.</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">CPF3C4D E</td>
|
|
<td align="left" valign="top">Length &1 for key &2 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C88 E</td>
|
|
<td align="left" valign="top">Number of variable length records &1 is 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">CPF36F7 E</td>
|
|
<td align="left" valign="top">Message queue QSYSOPR is allocated to another
|
|
job.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><img src="delta.gif"
|
|
alt="Start of change"> CPF7000 E</td>
|
|
<td align="left" valign="top">Errors from journaling.<img src="deltaend.gif"
|
|
alt="End of change"></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF7304 E</td>
|
|
<td align="left" valign="top">File &1 in &2 not changed.</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">CPF9811 E</td>
|
|
<td align="left" valign="top">Program &1 in library &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9812 E</td>
|
|
<td align="left" valign="top">File &1 in library &2 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9814 E</td>
|
|
<td align="left" valign="top">Device &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9815 E</td>
|
|
<td align="left" valign="top">Member &5 file &2 in library &3 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">CPF9821 E</td>
|
|
<td align="left" valign="top">Not authorized to program &1 in library
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9822 E</td>
|
|
<td align="left" valign="top">Not authorized to file &1 in library
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9825 E</td>
|
|
<td align="left" valign="top">Not authorized to device &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">CPF9831 E</td>
|
|
<td align="left" valign="top">Cannot assign device &1.</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: V2R2
|
|
|
|
<hr>
|
|
<table align="center" cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"obj1.htm">Object APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|
|
|