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

743 lines
20 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Open List of Authorized Users (QGYOLAUS) 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Open List of Authorized Users (QGYOLAUS) 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">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">5</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">6</td>
<td align="left" valign="top">Selection criteria</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Group profile name</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;Optional Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">9</td>
<td align="left" valign="top" width="50%">Profile name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</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 Open List of Authorized Users (QGYOLAUS) API provides information about
the authorized users of the system. It returns a list of authorized user names
that meet the selection criteria specified by the caller of the API and
information about those users. This API provides information similar to the
Display Authorized Users (DSPAUTUSR) command and the Retrieve Authorized Users
(QSYRAUTU) API.</p>
<br>
<h3>Differences between QSYRAUTU and QGYOLAUS</h3>
<p>The QGYOLAUS API returns the same information that the Retrieve Authorized
Users (QSYRAUTU) 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>Authority to User Profiles in List of Authorized Users</em></dt>
<dd>*READ
<p><strong>Note:</strong> Only those profiles to which you have *READ authority
are returned in the list.</p>
</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. If the length is larger than the size
of the receiver variable, the results are not predictable.</p>
</dd>
<dt><strong>List Information</strong></dt>
<dd>OUTPUT; CHAR(80)
<p>Information about the list created by this program. For a description of the
layout of this parameter, see <a href="../apiref/oli.htm">Format of Open List
Information</a>.</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
filtering and sorting has been done.</p>
<p>If -1 is specified for this parameter, the entire list is built
synchronously.</p>
<p>If 0 is specified for this parameter, the entire list is built
asynchronously in a server job.</p>
<p>If a positive number of records to return is specified, at least that many
records will be built synchronously and the remainder will be built
asynchronously in a server job.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the format that is used to return information about the
authorized users.</p>
<p>You can specify these formats:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td align="left" valign="top"><em><a href="#HDRSRI2G">AUTU0100</a></em></td>
<td align="left" valign="top">Each entry contains the user name, an indicator
that specifies whether the user is a user profile or a group profile, and an
indicator that specifies whether the user is a group that has members.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRSRI3G">AUTU0150</a></em></td>
<td align="left" valign="top">Each entry contains the same information as
AUTU0100 plus the text description for the user.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRSRI4X">AUTU0200</a></em></td>
<td align="left" valign="top">Each entry contains the same information as
AUTU0100 plus group profiles are returned for users who are members of one or
more groups.</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRSRIRA1Y">AUTU0250</a></em></td>
<td align="left" valign="top">Each entry contains the same information as
AUTU0200 plus the text description for the user.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Selection criteria</strong></dt>
<dd>INPUT; CHAR(10)
<p>This parameter specifies which users are returned. Possible special values
follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All user profile names and group profile names
are returned. This is the same list of users that are returned by the List
Authorized Users (QSYLAUTU) API.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*USER</em></td>
<td align="left" valign="top">User names that are not group profiles are
returned. (Users that do not have a GID specified in their user profiles.)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*GROUP</em></td>
<td align="left" valign="top">User names that are group profiles are returned.
(Users that have a GID specified in their user profiles.)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MEMBER</em></td>
<td align="left" valign="top">User names that are members of the group
specified by the group profile name parameter are returned. The users who do
not have any group profiles can be retrieved by specifying *NOGROUP for the
group profile name. The group profile name parameter must contain a valid group
profile name or *NOGROUP when the selection criteria is *MEMBER.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Group profile name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The group profile whose members are to be returned. The profile specified
must exist and must be a group profile.</p>
<p>A group profile name or *NOGROUP is required if *MEMBER is specified for the
selection criteria. The group profile name must be *NONE if the selection
criteria is not *MEMBER.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No group profile is specified.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>group name</em></td>
<td align="left" valign="top">Users who are a member of this group are
returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NOGROUP</em></td>
<td align="left" valign="top">Users who are not a member of any group are
returned.</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>Optional Parameter</h3>
<dl>
<dt><strong>Profile name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The profile names to include in the list. The selection criteria determines
which users are included in the list. Specifying a profile name can further
limit the names that are returned.</p>
<p>The profile name can be a simple name, a generic name, or the special value
*ALL. If not provided, *ALL is used as a default. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All profiles are listed.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>Profile name</em></td>
<td align="left" valign="top">If a generic profile name is specified, the
profiles that match the generic name are returned. If a simple profile name is
specified, only that profile is returned.<br>
</td>
</tr>
</table>
</dd>
</dl>
<br>
<h3><a name="HDRSRIRA1G">Receiver Variable Description</a></h3>
<p>The following tables describe the order and format of the data returned in
the receiver variable for each profile name in the list. For detailed
descriptions of the fields in the tables, see <a href="#HDRSRIRA5G">Field
Descriptions</a>.</p>
<br>
<h4><a name="HDRSRI2G">AUTU0100 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%">Profile name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">User or group indicator</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">0B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Group members indicator</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRSRI3G">AUTU0150 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%">Profile name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">User or group indicator</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">0B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Group members indicator</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">0C</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRSRI4X">AUTU0200 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%">Profile name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">User or group indicator</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">0B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Group members indicator</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 group profiles</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">ARRAY(16) of CHAR(10)</td>
<td align="left" valign="top">Group profiles</td>
</tr>
</table>
<br>
<br>
<h4><a name="HDRSRIRA1Y">AUTU0250 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%">Profile name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">0A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">User or group indicator</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">0B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Group members indicator</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">0C</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</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 group profiles</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">ARRAY(16) of CHAR(10)</td>
<td align="left" valign="top">Group profiles</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSRIRA5G">Field Descriptions</a></h3>
<p><strong>Group members indicator.</strong> Whether this user is a group that
has members. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The user is not a group, or is a group but does
not have any members.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The user is a group that has members.</td>
</tr>
</table>
<p><strong>Group profiles.</strong> The array of group profiles for the user.
The number of group profiles field indicates how many entries are in the
array.</p>
<p><strong>Number of group profiles.</strong> The number of group profiles that
are returned in the group profiles field. The number of group profiles will be
zero if the user is not a member of any group.</p>
<p><strong>Profile name.</strong> The name of an authorized user for whom
information is returned.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Text description.</strong> The descriptive text for the user
profile.</p>
<p><strong>User or group indicator.</strong> Whether this user is a user
profile or a group profile. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">User profile</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Group profile</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF22B4 E</td>
<td align="left" valign="top">Group profile &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF22B7 E</td>
<td align="left" valign="top">Profile &amp;1 is not a group profile.</td>
</tr>
<tr>
<td align="left" valign="top">CPF22E0 E</td>
<td align="left" valign="top">Group profile name cannot be *NONE when selection
criteria is *MEMBER.</td>
</tr>
<tr>
<td align="left" valign="top">CPF22ED E</td>
<td align="left" valign="top">Group profile name must be *NONE when selection
criteria is not *MEMBER.</td>
</tr>
<tr>
<td align="left" valign="top">CPF22EE E</td>
<td align="left" valign="top">Selection criteria is not valid.</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">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</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">CPF3C3A E</td>
<td align="left" valign="top">Value for parameter &amp;2 for API &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9821 E</td>
<td align="left" valign="top">Not authorized to program &amp;1 in library
&amp;2.</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>
<tr>
<td align="left" valign="top">GUI0002 E</td>
<td align="left" valign="top">&amp;2 is not valid for length of receiver
variable.</td>
</tr>
<tr>
<td align="left" valign="top">GUI0027 E</td>
<td align="left" valign="top">&amp;1 is not valid for number of records to
return.</td>
</tr>
</table>
<br>
<hr>
API introduced: V4R1
<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=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink