ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qsyupdui.htm

281 lines
7.7 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>Update User Application Information (QsyUpdateUserApplicationInfo)
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>Update User Application Information (QsyUpdateUserApplicationInfo) API</h2>
<p><img src="delta.gif" alt="Start of change"></p>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Syntax for QsyUpdateUserApplicationInfo:<br>
<pre>
#include &lt;qsyusrin.h&gt;
void QsyUpdateUserApplicationInfo
(char *<em>User_profile</em>,
char *<em>Application_information_ID</em>,
int *<em>Length_of_application_information_ID</em>,
char *<em>Application_information</em>,
int *<em>Length_of_application_information</em>,
char *<em>First_valid_release</em>,
void *<em>Error_code</em>);
</pre>
&nbsp;&nbsp;Service Program: QSYUSRIN<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p><img src="deltaend.gif" alt="End of change"></p>
<p>The Update User Application Information (QsyUpdateUserApplicationInfo) API
updates the specified application information for a user profile. The specified
information is stored in an object that is saved and restored with the user
profile.</p>
<p>The Change User Profile exit programs are not called from this API.</p>
<br>
<h3>Authorities and Locks</h3>
<p>If the user profile parameter is not *CURRENT or the user profile currently
running, then the user profile that calls this API must have *SECADM special
authority and *OBJMGT and *USE authorities to the user profile.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>User profile</strong></dt>
<dd>INPUT; CHAR(10)
<p>The user profile for which the application information will be updated. The
special value *CURRENT may be specified to update 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 entry to update. IBM-supplied i5/OS
application information IDs are named QIBM_<em>ccc</em>_<em>name</em>, where
<em>ccc</em> is the component identifier. User-supplied application information
IDs should not preface their application information ID with QIBM.
User-supplied application information IDs should start with the company name to
eliminate most problems that involve unique names. Application information IDs
should use an underscore (_) to separate parts of the name. Also, IDs for
related applications should start with the same name.</p>
<p>The first character of the application information ID must be one of the
following:<br>
<br>
</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top" width="10%"><em>A-Z</em></td>
<td align="left" valign="top" width="90%">Uppercase A-Z</td>
</tr>
</table>
<br>
<p>The remaining characters in the application information ID must be made up
of the following characters:<br>
<br>
</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top" width="10%"><em>A-Z</em></td>
<td align="left" valign="top" width="90%">Uppercase A-Z</td>
</tr>
<tr>
<td><em>0-9</em></td>
<td>Digits 0-9</td>
</tr>
<tr>
<td><em>.</em></td>
<td>Period</td>
</tr>
<tr>
<td><em>_</em></td>
<td>Underscore</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of application information ID</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the application information ID that is specified in the
application information ID parameter. The length of the application information
ID must be a value from 1 to 200.</p>
</dd>
<dt><strong>Application information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The application information to be associated with the specified user
profile.</p>
</dd>
<dt><strong>Length of application information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the application information that is specified in the
application information parameter. The length of the application information
must be a value from 1 to 1700.</p>
</dd>
<dt><strong>First valid release</strong></dt>
<dd>INPUT; CHAR(6)
<p>The first release that this application information is valid. This field is
used to determine the earliest release this user application information is
valid when saving a user profile to a previous release. If the user profile is
saved to a release previous to the release specified in this field, this
information will not be saved with the user profile information. This field
must be in the format VxRxMx (for example, V5R3M0). The release specified must
be V5R3M0 or greater.</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>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">CPF2204 E</td>
<td valign="top">User profile &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF2213 E</td>
<td valign="top">Not able to allocate user profile &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF2222 E</td>
<td valign="top">Storage limit is greater than specified for user profile
&amp;1.</td>
</tr>
<tr>
<td valign="top">CPF226C E</td>
<td valign="top">Not authorized to perform function.</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 &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF3C1D E</td>
<td valign="top">Length specified in parameter &amp;1 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">CPF4AA0 E</td>
<td valign="top">Application information ID &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF4AA1 E</td>
<td valign="top">First release value &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;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>