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/qsylatlo.htm

1289 lines
37 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>List Objects Secured by Authorization List (QSYLATLO) 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 April 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>List Objects Secured by Authorization List (QSYLATLO) API</h2>
<div class="box" style="width: 70%;">
<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 user space 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">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">3</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">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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The List Objects Secured by Authorization List (QSYLATLO) API puts a list of
objects secured by an authorization list into a user space.</p>
<p>This API provides information similar to the Display Authorization List
Objects (DSPAUTLOBJ) command.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>Authority to Library Containing User Space</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Authorization List Authority</em></dt>
<dd>Must not be *EXCLUDE authority</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The name of the existing user space where the list of objects secured by the
authorization list is returned to. The first 10 characters specify the user
space name, and the second 10 characters specify the library.</p>
<p>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 current library is used to locate the user
space. If there is no current library, QGPL (general purpose library)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list is used to locate the user
space.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the format used to list objects secured by the authorization
list.</p>
<p>You can specify these formats:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO3">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="#HDRLATLO11">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.LIB and QDLS file
systems are not returned with this format.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO4">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="#HDRLATLO21">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.LIB and QDLS file systems are not returned with this format.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO30">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 are returned with this format. Objects are returned
consecutively in three groups. Objects in the QSYS.LIB file system are in one
group, objects in the QDLS file system are in another group, and objects in
directories are in the other group. Information returned in the Header Section
of the user space indicates how to get to the beginning of each group of
objects.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRLATLO40">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. Objects are returned
consecutively in three groups. Objects in the QSYS.LIB file system are in one
group, objects in the QDLS file system are in another group, and objects in
directories are in the other group. Information returned in the Header Section
of the user space indicates how to get to the beginning of each group of
objects.</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><a name="HDRUSRSPCV">User Space Variables</a></h3>
<p>The following tables describe the order and format of the data returned in
the user space. For detailed descriptions of the fields in the tables, see <a
href="#HDRJOBLDE">Field Descriptions</a>. When you retrieve list entry
information for formats ATLO0100, ATLO0200, ATLO0300, or ATLO0400 you must
use the entry size returned in the generic header to access list entries as
the size of each entry may be padded at the end. If you do not use the entry
size, the result may not be valid. When you retrieve list entry
information for formats ATLO0110 and ATLO0210 you must use the <strong>offset
to path name</strong> of the current entry + the <strong>length of path
name</strong> of the current entry to access the next entry.
</p>
<br>
<h4><a name="HDRLATLO1">Input Parameter Section</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User space name specified</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">User space library name specified</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Authorization list</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO2">Header Section</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Authorization list</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">Authorization list 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">Owner</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Primary group</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">BINARY(4)</td>
<td align="left" valign="top">Offset to first QSYS.LIB object</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Entry number of first QSYS.LIB object</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</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">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to first QDLS object</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</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">64</td>
<td align="center" valign="top">40</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">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to first directory object</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</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">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of directory objects</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRLATLO3">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%">CHAR(10)</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="HDRLATLO11">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%">CHAR(10)</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="HDRLATLO4">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%">CHAR(10)</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="HDRLATLO21">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%">CHAR(10)</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="HDRLATLO30">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="left" valign="top" width="20%">CHAR(10)</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="HDRLATLO40">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="left" valign="top" width="20%">CHAR(10)</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 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="HDRJOBLDE">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.LIB 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
containing the authorization list.</p>
<p><strong>Displacement to path name.</strong> The displacement in the entry to
the start of the path name.</p>
<p><strong>DLO name.</strong> The document library object (DLO) name for the
object. If the object is not an *DOC (document) or *FLR (folder) object, this
field is blank.</p>
<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 is returned in the user space. 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 is returned in the user space. 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 is returned in the user space. 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>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>Format name.</strong> The name of the format that is used to list
objects secured by the authorization list.</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
user space, object, or authorization list.</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 are returned
in the user space. 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 user space, 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 user space. 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 user space, 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 user space. 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 user space, 0 is returned.</p>
<p><strong>Object name.</strong> The name of the object secured by the
authorization list. If the object is not in the QSYS.LIB or QDLS file system,
this field is blank.</p>
<p><strong>Object type.</strong> The type of secured object.</p>
<p><strong>Offset to first directory object.</strong> The offset to the first
directory object (objects not in the QSYS.LIB or QDLS file systems) that was
returned in the user space. This value is only set if using format ATLO0300 or
ATLO0400. Otherwise, -1 is returned. If 'Number of directory objects' is 0,
this value will also be 0.</p>
<p><strong>Offset to first QDLS object.</strong> The offset to the first QDLS
object that is returned in the user space. 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>Offset to first QSYS.LIB object.</strong> The offset to the first
QSYS.LIB object that is returned in the user space. 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>Offset to path name.</strong> The offset in the user space to the
start of 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 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 returned in the user
space.</p>
<p>The structure of the path name returned is:</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>
<br>
<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 will contain a value of *NONE.</p>
<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 user space contains all objects
meeting the search criteria.</li>
<li>Reason code 0001. Objects were found that meet the search criteria but
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
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 did not have links to
them.</li>
</ul>
<p><strong>Reserved.</strong> This field is not used.</p>
<p><strong>Text description.</strong> The descriptive text for the secured
object. If the object is not in the QSYS.LIB or QDLS file system, this field is
blank.</p>
<p><strong>User space library name specified.</strong> The name of the library
containing the user space or object.</p>
<p><strong>User space name specified.</strong> The user space used to return
the list of objects secured by the authorization list.</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">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: V2R2
<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