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

167 lines
4.9 KiB
HTML
Raw Normal View History

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>Restore User Profile Exit Program</title>
<!-- 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. -->
<!-- Begin Header Records ========================================== -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!--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>Restore User Profile Exit Program</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Required Parameter:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Restore profile exit information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
</table>
<br>
<pre>
QSYSINC Member Name: ERSTPRF1
Exit Point Name: QIBM_QSY_RST_PROFILE
Exit Point Format Name: RSTP0100
</pre>
</div>
<p>The Restore User Profile exit program is called when a user profile is
restored on the iSeries server.</p>
<p>When a user profile is restored to the iSeries server, the operating system
calls the user-written exit programs through the registration facility.</p>
<p>During a restore operation of the entire system, all required objects are
not installed at the time user profiles are being restored. Therefore, this
exit point is not active during a restore operation of the entire system.</p>
<p>This exit point supports up to 20 exit programs. (For information about
adding an exit program to an exit point, see the Registration Facility
part.)</p>
<p><strong>Note:</strong> The Restore User Profile exit program ignores any
return codes or error messages that are sent from the exit program.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Profile Authority</em></dt>
<dd>*ALLOBJ and *SECADM to add exit programs to the registration facility</dd>
</dl>
<br>
<h3>Required Parameter</h3>
<dl>
<dt><strong>Restore profile exit information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information needed by the exit program for notification of any profile
restored. For details, see <a href="#HDRRSTFMT">Format of Restore Profile Exit
Information</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRRSTFMT">Format of Restore Profile Exit Information</a></h3>
<p>The following table shows the structure of the restore profile exit
information for format RST0100. For a description of the fields in this format,
see <a href="#HDRRSTI">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="top" 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="top">Dec</th>
<th align="center" valign="top">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(20)</td>
<td align="left" valign="top" width="60%">Exit point 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">Exit point 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 profile name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRSTI">Field Descriptions</a></h3>
<p><strong>Exit point format name.</strong> The format name for the Restore
User Profile exit program. The possible format name is:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RSTP0100</em></td>
<td align="left" valign="top">The format name that is used after a user profile
is restored.</td>
</tr>
</table>
<p><strong>Exit point name.</strong> The name of the exit point that calls the
exit program.</p>
<p><strong>User profile name.</strong> The name of the user profile that was
restored.</p>
<br>
<hr>
Exit program introduced: V3R7
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<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>