430 lines
12 KiB
HTML
430 lines
12 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Retrieve User Application Information (QsyRetrieveUserApplicationInfo)
|
||
|
|
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 -->
|
||
|
|
<!-- October 2002 Created -->
|
||
|
|
<!-- October 2002 HTML cleanup by JET -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Retrieve User Application Information (QsyRetrieveUserApplicationInfo)
|
||
|
|
API</h2>
|
||
|
|
|
||
|
|
<p><img src="delta.gif" alt="Start of change"></p>
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Syntax for QsyRetrieveUserApplicationInfo:<br>
|
||
|
|
<pre>
|
||
|
|
#include <qsyusrin.h>
|
||
|
|
|
||
|
|
void QsyRetrieveUserApplicationInfo
|
||
|
|
(void *<em>Receiver_variable</em>,
|
||
|
|
int *<em>Length_of_receiver_variable</em>,
|
||
|
|
void *<em>Return_records_feedback_information</em>,
|
||
|
|
char *<em>Format_name</em>,
|
||
|
|
char *<em>User_profile</em>,
|
||
|
|
char *<em>Application_information_ID</em>,
|
||
|
|
int *<em>Length_of_application_information_ID</em>,
|
||
|
|
void *<em>Error_code</em>);
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
Service Program: QSYUSRIN<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
<p><img src="deltaend.gif" alt="End of change"></p>
|
||
|
|
|
||
|
|
|
||
|
|
<p>The Retrieve User Application Information (QsyRetrieveUserApplicationInfo)
|
||
|
|
API returns a list of application information entries for a user profile.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>User Profile Authority</em></dt>
|
||
|
|
|
||
|
|
<dd><em>*READ</em></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.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Returned records feedback information</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(12)
|
||
|
|
|
||
|
|
<p>Information about the entries that are returned in the receiver
|
||
|
|
variable.</p>
|
||
|
|
|
||
|
|
<p>See <a href="#HDRRTVUIRR">Format of Returned Records Feedback
|
||
|
|
Information</a> for details.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The name of the format that is used to retrieve application information
|
||
|
|
entries for the user profile.</p>
|
||
|
|
|
||
|
|
<p>You can specify this format:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="30 70" -->
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><em>RUAI0100</em></td>
|
||
|
|
<td valign="top">For a detailed description of this format, see <a
|
||
|
|
href="#HDRRUAI100">RUAI0100 Format</a>.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>User profile</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The name of the user profile for which the application information will be
|
||
|
|
retrieved. The special value *CURRENT may be specified to retrieve application
|
||
|
|
information for the user profile that calls this API.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Application information ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The ID for the application information to retrieve. The following can be
|
||
|
|
specified for the application information ID:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>generic*</strong></dt>
|
||
|
|
|
||
|
|
<dd>All application information IDs that have IDs beginning with the generic
|
||
|
|
string will be retrieved.</dd>
|
||
|
|
|
||
|
|
<dt><strong>application information ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>Specific application information ID will be retrieved.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dd><br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of application information ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the application information ID. The length of the application
|
||
|
|
information ID may be from 1 to 200.</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="HDRSYRAUI1">Receiver Variable Description</a></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="#HDRSYRUAI3">Field Descriptions</a>.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h4><a name="HDRRUAI100">RUAI0100 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%">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(200)</td>
|
||
|
|
<td align="left" valign="top">Application information ID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">204</td>
|
||
|
|
<td align="center" valign="top">CC</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Displacement to user application information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">208</td>
|
||
|
|
<td align="center" valign="top">D0</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of user application information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">212</td>
|
||
|
|
<td align="center" valign="top">D4</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">CCSID of user application information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">216</td>
|
||
|
|
<td align="center" valign="top">D8</td>
|
||
|
|
<td align="left" valign="top">CHAR(6)</td>
|
||
|
|
<td align="left" valign="top">First valid release</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top"></td>
|
||
|
|
<td align="center" valign="top"></td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">User application information</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRRTVUIRR">Format of Returned Records Feedback
|
||
|
|
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%">Bytes returned</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">Bytes available</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">Number of user application information
|
||
|
|
entries</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRSYRUAI3">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Application information ID.</strong> The application information ID
|
||
|
|
that identifies this entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
||
|
|
be returned to the user in the receiver variable. If all data is returned,
|
||
|
|
bytes available is the same as the number of bytes returned. If the receiver
|
||
|
|
variable was not large enough to contain all of the data, this value is
|
||
|
|
estimated based on the total number of application information entries for the
|
||
|
|
user profile and the format specified.</p>
|
||
|
|
|
||
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned to the
|
||
|
|
user in the receiver variable. This is the lesser of the number of bytes
|
||
|
|
available to be returned or the length of the receiver variable.</p>
|
||
|
|
|
||
|
|
<p><strong>CCSID of user application information.</strong> The CCSID of the
|
||
|
|
user application information. This will be the default job CCSID of the job
|
||
|
|
that last updated the user application information.</p>
|
||
|
|
|
||
|
|
<p><strong>Displacement to user application information.</strong> The
|
||
|
|
displacement in the entry to the start of the user application information.</p>
|
||
|
|
|
||
|
|
<p><strong>First valid release.</strong> The first release that this
|
||
|
|
application information is valid. This field will be in the format VxRxMx (for
|
||
|
|
example, V5R3M0).</p>
|
||
|
|
|
||
|
|
<p><strong>Length of entry.</strong> The length (in bytes) of the current
|
||
|
|
entry. This length can be used to access the next entry.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of user application information.</strong> The length (in
|
||
|
|
bytes) of the user application information.</p>
|
||
|
|
|
||
|
|
<p><strong>Number of user application information entries.</strong> The number
|
||
|
|
of complete entries returned in the list of user application information
|
||
|
|
entries. A value of zero is returned if the list is empty.</p>
|
||
|
|
|
||
|
|
<p><strong>User application information.</strong> The user application
|
||
|
|
information that is associated with the user profile.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPFA0AA E</td>
|
||
|
|
<td valign="top">Error occurred while attempting to obtain space.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2204 E</td>
|
||
|
|
<td valign="top">User profile &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2213 E</td>
|
||
|
|
<td valign="top">Not able to allocate user profile &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2217 E</td>
|
||
|
|
<td valign="top">Not authorized to user profile &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF2222 E</td>
|
||
|
|
<td valign="top">Storage limit is greater than specified for user profile
|
||
|
|
&1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF2 E</td>
|
||
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C1D E</td>
|
||
|
|
<td valign="top">Length specified in parameter &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C21 E</td>
|
||
|
|
<td valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C90 E</td>
|
||
|
|
<td valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R3
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|