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

800 lines
22 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>List Signed-On Users (QEZLSGNU) 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. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited Oct 2001 by v2cdijab -->
<!--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 Signed-On Users (QEZLSGNU) 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%">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">User name</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">Display station name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Include disconnected jobs and<br>
suspended group jobs</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Include signed-off users with output waiting to
print</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">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 List Signed-On Users (QEZLSGNU) API generates a list of signed-on users
and places the list in the specified user space. The generated list replaces
any existing lists in the user space.</p>
<p>When you specify a generic user name or a generic display station name, you
can generate a subset of the signed-on user list. If both a user name and a
display station name are specified, only entries that match both the user name
and the display station name are included in the list of signed-on users.</p>
<p>You can use the QEZLSGNU API to get a list of users similar to that seen by
using the Work with User Jobs (WRKUSRJOB) command with options STATUS (*ACTIVE)
and JOBTYPE (*INTERACT).</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive the created list. The first 10 characters
contain the user space name, and the second 10 characters contain the name of
the library where the user space is located. You can use these special values
for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information returned for each member. The
possible format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>SGNU0100</em></td>
<td align="left" valign="top">This format returns information about the user's
job and what kind of activity they are performing.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SGNU0200</em></td>
<td align="left" valign="top">This format returns the same information as the
SGNU0100 format, plus the text descriptions of the user profile and display
station. This format requires more processing than the SGNU0100 format.</td>
</tr>
</table>
<p>For more information, see <a href="#HDRSGNU1">SGNU0100 Format</a> or <a
href="#HDRSGNU2">SGNU0200 Format</a>.</p>
</dd>
<dt><strong>User name</strong></dt>
<dd>INPUT; CHAR(10)
<p>A specific user name, a generic user name, or the following special
value:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All signed-on users</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Display station name</strong></dt>
<dd>INPUT; CHAR(10)
<p>A specific display station name, a generic display station name, or the
following special value:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All display stations with signed-on users</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Include disconnected jobs and suspended group jobs</strong></dt>
<dd>INPUT; CHAR(10)
<p>An indicator for whether or not to include disconnected jobs and suspended
group jobs. You must use one of the following special values:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Include signed-on users with disconnected jobs
and users whose group jobs have been suspended.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Do not include signed-on users with disconnected
jobs and users whose group jobs have been suspended.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Include signed-off users with output waiting to print</strong></dt>
<dd>INPUT; CHAR(10)
<p>An indicator for whether or not to include signed-off users with output
waiting to print. This would include all interactive signed-off users with
output waiting to print and all batch graphical user interface jobs that have
ended with output waiting to print.</p>
<p>You must use one of the following special values:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Include signed-off users with output waiting to
print.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Do not include signed-off users with output
waiting to print.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRSGNULST">Format of the Generated Lists</a></h3>
<p>The signed-on user list consists of:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A list data section:
<ul>
<li>SGNU0100 format</li>
<li>SGNU0200 format</li>
</ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">User spaces.</a>
For details about
the remaining items, see the following sections. For detailed descriptions of
the fields in the list returned, see <a href="#HDRLSGNUDE">Field
Descriptions</a>.</p>
<p>When you retrieve list entry information from a user space, you must use the
entry size returned in the generic header. 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. For
examples of how to process lists, see <a href="../apiref/apiexmp.htm">API
Examples</a>.</p>
<br>
<h3><a name="HDRSGNUIP1">Input Parameter Section</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User space name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space 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(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">User name specified</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Display station specified</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Include disconnected jobs and suspended group
jobs indicator specified</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="center" valign="top">3A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Include signed-off users with output waiting to
print indicator specified</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSGNU1">SGNU0100 Format</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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Display station name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="center" valign="top">1A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Activity</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Activity name</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Disconnect job allowed indicator</td>
</tr>
<tr>
<td align="center" valign="top">47</td>
<td align="center" valign="top">2F</td>
<td align="left" valign="top">CHAR(17)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSGNU2">SGNU0200 Format</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%">&nbsp;</td>
<td align="left" valign="top" width="60%">Everything from the SGNU0100
format</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Display station description</td>
</tr>
<tr>
<td align="center" valign="top">114</td>
<td align="center" valign="top">72</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">User description</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLSGNUDE">Field Descriptions</a></h3>
<p><strong>Activity.</strong> Information about what is happening with the
interactive job. Valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*BLDIDX</em></td>
<td align="left" valign="top">The user is using a file that is currently being
rebuilt. The user's interactive job will be delayed until the file rebuild
operation is complete or the Transfer to Secondary Job (TFRSECJOB) command has
been run. The file name is in the activity name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CMD</em></td>
<td align="left" valign="top">The user is running a command. The command name
is in the activity name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CMDENT</em></td>
<td align="left" valign="top">The user is currently on the Command Entry
display.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DLY</em></td>
<td align="left" valign="top">The Delay Job (DLYJOB) command has been run, and
the user's interactive job will be delayed until the time limit specified has
passed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DSCJOB</em></td>
<td align="left" valign="top">The user is temporarily signed-off (disconnected)
the system (for example, option 80 on the ASSIST menu).</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DUMP</em></td>
<td align="left" valign="top">The user encountered an unexpected error, and a
printout of diagnostic information (dump) is being created.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*GRP</em></td>
<td align="left" valign="top">The job is a suspended group job. The group name
is in the activity name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*HLD</em></td>
<td align="left" valign="top">The user's interactive job is temporarily stopped
and cannot run until it is released.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MNU</em></td>
<td align="left" valign="top">The user is using a menu. The menu name is in the
activity name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MSG</em></td>
<td align="left" valign="top">The user is waiting for a reply to a
message.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PGM</em></td>
<td align="left" valign="top">The user is running a program. The program name
is in the activity name field.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRT</em></td>
<td align="left" valign="top">The job has ended but has output waiting to
print.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SIGNOFF</em></td>
<td align="left" valign="top">A job is ending because the user has signed off
the system, or the interactive job has ended due to one of the following:<br>
<ul>
<li>End Job (ENDJOB) command</li>
<li>End Subsystem (ENDSBS) command</li>
<li>End Group Job (ENDGRPJOB) command</li>
<li>An unexpected error</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSRQS</em></td>
<td align="left" valign="top">The user has pressed the System Request key.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*S36PRC</em></td>
<td align="left" valign="top">The user is running a System/36 environment
procedure. The procedure name is in the activity name field.</td>
</tr>
</table>
<p><strong>Activity name.</strong> The name of the program, menu, command,
System/36 procedure, or file being used; or the group name of a suspended group
job. The field is used only when the activity field is *PGM, *MNU, *CMD,
*S36PRC, *BLDIDX, or *GRP. This field is blank for other activities.</p>
<p><strong>Disconnect job allowed indicator.</strong> An indicator as to
whether the job is allowed to be disconnected or not using the Disconnect Job
(DSCJOB) command. The valid values that will be returned are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The job is allowed to be disconnected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The job is not allowed to be disconnected.</td>
</tr>
</table>
<p><strong>Display station description.</strong> The text that describes the
device description of the display station to which the user is signed on.</p>
<p><strong>Display station name.</strong> The name of the display station to
which the user is currently signed on. This field is used as part of the job
name by the system.</p>
<p><strong>Display station specified.</strong> The display station or special
value specified in the call to this API.</p>
<p><strong>Format name.</strong> The name of the format that determines the
content of the information returned for each signed-on user. This is specified
on the call to this API.</p>
<p><strong>Include disconnected jobs and suspended group jobs indicator
specified.</strong> The include disconnected jobs and suspended group jobs
indicator specified in the call to this API.</p>
<p><strong>Include signed-off users with output waiting to print indicator
specified.</strong> The include signed-off users with output waiting to print
indicator specified in the call to this API.</p>
<p><strong>Job number.</strong> The system-assigned job number.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>User description.</strong> The text of the user profile description
for the user currently signed on the system.</p>
<p><strong>User name.</strong> The user profile name of the user currently
signed on the system.</p>
<p><strong>User name specified.</strong> The user name or special value
specified in the call to this API.</p>
<p><strong>User space library name.</strong> The library in which the user
space is located.</p>
<p><strong>User space name.</strong> The name of the user space that is to
receive the generated list and the name of the library that contains this user
space. This is specified in the call to this API.</p>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">CPF1EA1 E</td>
<td align="left" valign="top" width="85%">User name parameter is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1EA2 E</td>
<td align="left" valign="top">Display station parameter is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1EA3 E</td>
<td align="left" valign="top">Include disconnected jobs parameter is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1EA4 E</td>
<td align="left" valign="top">Include signed-off users with output parameter
not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1E99 E</td>
<td align="left" valign="top">Unexpected error occurred.</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">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">CPF811A E</td>
<td align="left" valign="top">User space &amp;4 in &amp;9 damaged.</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">CPF9804 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 damaged.</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: V2R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"oa1.htm">Operational Assistant APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue Copy Permalink