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

1423 lines
40 KiB
HTML
Raw Permalink 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>Retrieve Objects Secured by Authorization List (QGYRATLO) 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. -->
<!-- Sec 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 Dec 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>Retrieve Objects Secured by Authorization List (QGYRATLO) 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%">Receiver variable</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">List information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(80)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Section information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(64)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Number of records to return</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Authorization list</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">8</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 Retrieve Objects Secured by Authorization List (QGYRATLO) API provides a
list of objects that are secured by an authorization list. This API provides
information similar to the Display Authorization List Objects (DSPAUTLOBJ)
command and the List Objects Secured by Authorization List (QSYLATLO) API.</p>
<br>
<h3>Differences between QSYLATLO and QGYRATLO</h3>
<p>The QGYRATLO API returns the same information that the List Objects Secured
by Authorization List (QSYLATLO) API provides, but takes a complete snapshot at
once and allows subsequent records to be obtained through the Get List Entries
(QGYGTLE) API.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Authorization List Authority</em></dt>
<dd>Must not be *EXCLUDE authority</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length parameter correctly. As a result, the API returns only
the data that the area can hold.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided. The length of receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. For formats that contain
variable length data, the receiver variable length must be large enough to hold
the fixed portion of the record.</p>
</dd>
<dt><strong>List information</strong></dt>
<dd>OUTPUT; CHAR(80)
<p>The variable that is used to return status information about the list of
secured objects that were opened. See <a href="#HDRRATLOLI">Format of List
Information</a> for a description of this parameter.</p>
</dd>
<dt><strong>Section information</strong></dt>
<dd>OUTPUT; CHAR(64)
<p>The variable that is used to return entry information about the list of
secured objects that was opened. See <a href="#HDRRATLOSI">Format of Section
Information</a> for a description of this parameter.</p>
</dd>
<dt><strong>Number of records to return</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of records in the list to put into the receiver variable after
the entire list has been built. If -1 is specified, then all the records will
be returned.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the format that is used to list objects secured by the
authorization list.</p>
<p>You can specify these formats:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em> <a href="#HDRLATLO3X">ATLO0100</a></em></td>
<td align="left" valign="top">Each entry contains the object name, library,
type, authority holder indicator, auxiliary storage pool (ASP) device name of library, and ASP
device name of object.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO1X">ATLO0110</a></em></td>
<td align="left" valign="top">This format only returns path names for objects
in a directory. Each entry contains the offset to the path name, the length of
the path name, type, authority holder indicator, ASP device name of object, and the path name value.
Objects in the QSYS and QDLS file systems are not returned with this format.</td>
</tr>
<tr>
<td align="left" valign="top"><em> <a href="#HDRLATLO4G">ATLO0200</a></em></td>
<td align="left" valign="top">Each entry contains the same information as
ATLO0100 plus the object owner, attribute, text, and primary group.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO2G">ATLO0210</a></em></td>
<td align="left" valign="top">This format only returns path names for objects
in a directory. Each entry contains the same information as format ATLO0110
plus the object owner, attribute, text, and primary group. Objects in the QSYS
and QDLS file systems are not returned with this format.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO31">ATLO0300</a></em></td>
<td align="left" valign="top">Each entry contains the length of the entry,
object name, library, type, authority holder indicator, document library object
(DLO) name, the name of the folder that the DLO is in, the displacement to the
path name, the length of the path name, ASP device name of library, ASP device name of object, and
the path name value. Objects in
all file systems will be returned with this format.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO4Y">ATLO0400</a></em></td>
<td align="left" valign="top">Each entry contains the same information as
ATLO0300 plus the object owner, primary group, attribute, and text. Objects in
all file systems are returned with this format.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Authorization list</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the authorization list for which the secured objects are
returned.</p>
</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>Format of Receiver Variable</h3>
<p>The following tables describe the order and format of the data returned in
the receiver variable. For detailed descriptions of the fields in the tables,
see <a href="#HDRJOBLDG">Field Descriptions</a>.</p>
<br>
<h4><a name="HDRLATLO3X">ATLO0100 Format</a></h4>
<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%">Object name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authority holder</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of library</td>
</tr>
<tr>
<td align="center" valign="top">41</td>
<td align="center" valign="top">29</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of object</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO1X">ATLO0110 Format</a></h4>
<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%">Offset to path name</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 path name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authority holder</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of object</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Path name</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO4G">ATLO0200 Format</a></h4>
<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%">Object name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authority holder</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Owner</td>
</tr>
<tr>
<td align="center" valign="top">41</td>
<td align="center" valign="top">29</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Attribute</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="center" valign="top">33</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">101</td>
<td align="center" valign="top">65</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Primary group</td>
</tr>
<tr>
<td align="center" valign="top">111</td>
<td align="center" valign="top">6F</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of library</td>
</tr>
<tr>
<td align="center" valign="top">121</td>
<td align="center" valign="top">79</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of object</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO2G">ATLO0210 Format</a></h4>
<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%">Offset to path name</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 path name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authority holder</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="center" valign="top">13</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Owner</td>
</tr>
<tr>
<td align="center" valign="top">29</td>
<td align="center" valign="top">1D</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Attribute</td>
</tr>
<tr>
<td align="center" valign="top">39</td>
<td align="center" valign="top">27</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">89</td>
<td align="center" valign="top">59</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Primary group</td>
</tr>
<tr>
<td align="center" valign="top">99</td>
<td align="center" valign="top">63</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of object</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Path name</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO31">ATLO0300 Format</a></h4>
<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="center" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of entry</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object name</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">0E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">34</td>
<td align="center" valign="top">22</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authority holder</td>
</tr>
<tr>
<td align="center" valign="top">35</td>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">DLO name</td>
</tr>
<tr>
<td align="center" valign="top">47</td>
<td align="center" valign="top">2F</td>
<td align="left" valign="top">CHAR(63)</td>
<td align="left" valign="top">Folder name</td>
</tr>
<tr>
<td align="center" valign="top">110</td>
<td align="center" valign="top">6E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to path name</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of path name</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of library</td>
</tr>
<tr>
<td align="center" valign="top">130</td>
<td align="center" valign="top">82</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of object</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Path name</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO4Y">ATLO0400 Format</a></h4>
<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="center" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of entry</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object name</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">0E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Library name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">34</td>
<td align="center" valign="top">22</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authority holder</td>
</tr>
<tr>
<td align="center" valign="top">35</td>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">DLO name</td>
</tr>
<tr>
<td align="center" valign="top">47</td>
<td align="center" valign="top">2F</td>
<td align="left" valign="top">CHAR(63)</td>
<td align="left" valign="top">Folder name</td>
</tr>
<tr>
<td align="center" valign="top">110</td>
<td align="center" valign="top">6E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to path name</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of path name</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Owner</td>
</tr>
<tr>
<td align="center" valign="top">130</td>
<td align="center" valign="top">82</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Attribute</td>
</tr>
<tr>
<td align="center" valign="top">140</td>
<td align="center" valign="top">8C</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">190</td>
<td align="center" valign="top">BE</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Primary group</td>
</tr>
<tr>
<td align="center" valign="top">200</td>
<td align="center" valign="top">C8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name of library</td>
</tr>
<tr>
<td align="center" valign="top">210</td>
<td align="center" valign="top">D2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ASP device name object</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Path name</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRJOBLDG">Field Descriptions</a></h4>
<p><strong>ASP device name of
library.</strong> The auxiliary storage pool (ASP) device name where the
object's library is stored. If the object's library is in the system ASP or one
of the basic user ASPs, this field contains *SYSBAS.</p>
<p><strong>ASP device name of object.</strong> The auxiliary storage pool (ASP)
device name where the object is stored. If the object is in the system ASP or
one of the basic user ASPs, this field contains *SYSBAS.</p>
<p><strong>Attribute.</strong> The attribute of the secured object. If the
object is not in the QSYS or QDLS file system, this field is blank.</p>
<p><strong>Authority holder.</strong> Whether the object is an authority
holder. If the object is an authority holder, this field is Y. If not, this
field is N.</p>
<p><strong>Authorization list.</strong> The name of the authorization list for
which the list of objects is returned.</p>
<p><strong>Authorization list library name.</strong> The name of the library
that contains the authorization list.</p>
<p><strong>Displacement to path name.</strong> The displacement in the entry to
the start of the path name. The displacement will be set to zero if the
receiver variable is not large enough to hold the path name.</p>
<p><strong>DLO name.</strong> The document library object (DLO) name for the
object. If the object is not a *DOC (document) or *FLR (folder) object, this
field is blank.</p>
<p><strong>Folder name.</strong> The name of the folder that contains the DLO
object. If the object is not in a folder, this field contains *NONE.</p>
<p><strong>Length of entry.</strong> The length (in bytes) of the current
entry.</p>
<p><strong>Length of path name.</strong> The length (in bytes) of the path
name.</p>
<p><strong>Library name.</strong> The name of the library that contains the
object.</p>
<p><strong>Object name.</strong> The name of the object that is secured by the
authorization list. If the object is not in the QSYS or QDLS file system, this
field is blank.</p>
<p><strong>Object type.</strong> The type of secured object.</p>
<p><strong>Offset to path name.</strong> The offset in the receiver variable to
the start of the path name. The offset will be set to zero if the receiver
variable is not large enough to hold the path name.</p>
<p><strong>Owner.</strong> The name of the owner of the authorization list or
object.</p>
<p><strong>Path name.</strong> The path name of the object that is secured by
the authorization list. The user must request a format that supports path names
if path names are to be included in the information that is returned in the
receiver variable. The structure of the path name returned follows:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<th align="left" valign="top">Description</th>
<th align="left" valign="top">Type</th>
</tr>
<tr>
<td align="left" valign="top">CCSID of the returned path name</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="left" valign="top">Country or region ID</td>
<td align="left" valign="top">Char(2)</td>
</tr>
<tr>
<td align="left" valign="top">Language ID</td>
<td align="left" valign="top">Char(3)</td>
</tr>
<tr>
<td align="left" valign="top">Reserved field</td>
<td align="left" valign="top">Char(3)</td>
</tr>
<tr>
<td align="left" valign="top">Flag byte</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="left" valign="top">Number of bytes in the path name</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="left" valign="top">Path delimiter</td>
<td align="left" valign="top">Char(2)</td>
</tr>
<tr>
<td align="left" valign="top">Reserved field</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="left" valign="top">Path name value</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<p><strong>Primary group.</strong> The name of the user who is the primary
group for the authorization list or object. If there is no primary group for
the authorization list or object, this field contains a value of *NONE.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Text description.</strong> The descriptive text for the secured
object. If the object is not in the QSYS or QDLS file system, this field is
blank.</p>
<br>
<h3><a name="HDRRATLOLI">Format of List Information</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%">Total records</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">Records returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Request handle</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Record length</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Information complete indicator</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Date and time created</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">List status indicator</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of information returned</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">First record in buffer</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reason code</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(36)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLIFD">Field Descriptions</a></h3>
<p><strong>Date and time created.</strong> The date and time when the list was
created.</p>
<p>The 13 characters are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td width="15%" valign="top">0</td>
<td width="85%" 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">2-7</td>
<td align="left" valign="top">The date, in YYMMDD (year, month, and day)
format.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap>8-13</td>
<td align="left" valign="top">The time of day, in HHMMSS (hours, minutes, and
seconds) format.</td>
</tr>
</table>
<p><strong>First record in buffer.</strong> The number of the first record in
the receiver variable.</p>
<p><strong>Information complete indicator.</strong> Whether all requested
information has been supplied.<br>
Possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>I</em></td>
<td valign="top">Incomplete information. An interruption causes the
list to contain incomplete information about a buffer or buffers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">Partial and accurate information. Partial
information is returned when the maximum space was used and not all of the
buffers requested were read.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Complete and accurate information. All the
buffers requested are read and returned.</td>
</tr>
</table>
<br>
<p><strong>Length of information returned.</strong> The size, in bytes, of the
information that is returned in the receiver variable.</p>
<p><strong>List status indicator.</strong> The status of building the list.</p>
<p>Possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td width="15%" valign="top"><em>2</em></td>
<td width="85%" valign="top">The list has been completely built.</td>
</tr>
</table>
<br>
<p><strong>Reason code.</strong> The reason code that further describes why the
list is only a subset of all objects. The following values can be returned:</p>
<ul>
<li>Reason code 0000. The list returned in the receiver variable contains all
objects that meet the search criteria.</li>
<li>Reason code 0001. Objects were found that meet the search criteria, but
they could not be included in the returned list. The requested format could not
handle path names for directory objects.</li>
<li>Reason code 0002. Objects were found that meet the search criteria, but
they could not be included in the returned list. The requested format could not
handle objects found in library QSYS.</li>
<li>Reason code 0003. Directory objects were found, but they did not have links
to them.</li>
</ul>
<br>
<p><strong>Record length.</strong> The length of each record of information
returned. For variable length records, this value is set to zero. For variable
length records you can obtain the length of individual records from the records
themselves.</p>
<p><strong>Records returned.</strong> The number of records returned in the
receiver variable. This is the smallest of the following three values:</p>
<ul>
<li>The number of records that will fit into the receiver variable.</li>
<li>The number of records in the list.</li>
<li>The number of records that are requested.</li>
</ul>
<br>
<p><strong>Request handle.</strong> The handle of the request that can be used
for subsequent requests of information from the list. The handle is valid until
the Close List (QGYCLST) API is called to close the list, or until the job
ends.</p>
<p><strong>Note:</strong> This field should be treated as a hexadecimal field.
It should not be converted from one CCSID to another, for example, EBCDIC to
ASCII, because doing so could result in an unusable value.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Total records.</strong> The total number of records available in the
list.</p>
<br>
<h3><a name="HDRRATLOSI">Format of Section Information</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%">Entry number of first QSYS.LIB
object</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">Number of QSYS.LIB objects</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">Entry number of first QDLS object</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">0C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of QDLS objects</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Entry number of first directory object</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of directory objects</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSIFD">Field Descriptions</a></h3>
<p><strong>Entry number of first directory object.</strong> The entry number of
the first directory object (objects not in the QSYS.LIB or QDLS file system)
that was returned in the receiver variable. This value is only set if you are
using format ATLO0300 or ATLO0400. Otherwise, -1 is returned. If the number of
directory objects field is 0, this value is also 0.</p>
<p><strong>Entry number of first QDLS object.</strong> The entry number of the
first QDLS object that was returned in the receiver variable. This value is
only set if you are using format ATLO0300 or ATLO0400. Otherwise, -1 is
returned. If the number of QDLS objects field is 0, this value is also 0.</p>
<p><strong>Entry number of first QSYS.LIB object.</strong> The entry number of
the first QSYS.LIB object that was returned in the receiver variable. This
value is only set if you are using format ATLO0300 or ATLO0400. Otherwise, -1
is returned. If the number of QSYS.LIB objects field is 0, this value is also
0.</p>
<p><strong>Number of directory objects.</strong> The number of objects in
directories (objects not in the QSYS.LIB or QDLS file system) that were
returned in the receiver variable. This value is only set if you are using
format ATLO0300 or ATLO0400. Otherwise, -1 is returned. If there are no entries
for objects in directories in the receiver variable, 0 is returned.</p>
<p><strong>Number of QDLS objects.</strong> The number of objects in the QDLS
file system that were returned in the receiver variable. This value is only set
if you are using format ATLO0300 or ATLO0400. Otherwise, -1 is returned. If
there are no entries for QDLS objects in the receiver variable, 0 is
returned.</p>
<p><strong>Number of QSYS.LIB objects.</strong> The number of objects in the
QSYS.LIB file system that were returned in the receiver variable. This value is
only set if you are using format ATLO0300 or ATLO0400. Otherwise, -1 is
returned. If there are no entries for QSYS.LIB objects in the receiver
variable, 0 is returned.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<br>
<h3>Error Messages</h3>
<table width="100%">
<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">CPF22AF E</td>
<td width="85%" valign="top">Not authorized to authorization list &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2283 E</td>
<td align="left" valign="top">Authorization list &amp;1 does not exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2289 E</td>
<td align="left" valign="top">Unable to allocate authorization list
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CAA E</td>
<td align="left" valign="top">List is too large for user space &amp;1.</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">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;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">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;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 &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &amp;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 &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink