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

165 lines
5.6 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>QLPUSER Exit Program</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. -->
<!-- QLPUSPRG SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 21 Oct 1998 at 18:11:10 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 2002 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>QLPUSER Exit Program</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;<img src="delta.gif" alt="Start of change">Optional 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%">Device name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="50%">Install success</td>
<td align="left" valign="top" width="20%">Ouptut</td>
<td align="left" valign="top" width="20%">Char(1)<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p><img src="delta.gif" alt="Start of change">The QLPUSER user-defined exit program will be called during the automatic installation
process. It can be used to restore products that are not listed on the Licensed
Program menu or perform any other post install functions required on the target system. QLPUSER,
if it exists in QGPL, will be called in the following situations:
</p>
<ol>
<li>Install was successful.</li>
<li>Install was unsuccessful, however, QGPL and QUSRSYS were successfully installed, and the
QLPUSER program was created with both optional parameters.</li>
</ol>
<p><strong>Note:</strong> If QGPL or QUSRSYS fail to install, QLPUSER will not be called.</p>
<p> More information about the QLPUSER user-defined exit program can be found in the information
center topic:
<a href="../rzai4/rzai4wrtqlpuser.htm">Write a user-defined installation program for the target systems</a>.
</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>Device name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The device name that identifies the media device to be used for any user-defined restore
operations.</p>
</dd>
</dl>
<dl>
<dt><strong>Install success</strong></dt>
<dd>OUTPUT; CHAR(1)
<p>This parameter will let you know whether or not the install was successful.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The install was unsuccessful. One or more licensed programs failed to install. QGPL and
QUSRSYS, however, were installed successfully.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The install was successful.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
</dd>
</dl>
<br>
<h3>QLPUSER Exit Program Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a> for information
pertaining to code examples.</p>
<p><img src="delta.gif" alt="Start of change">The following control language (CL) program is an example of a user-defined installation
program that:</p>
<ul>
<li>Sends an instruction to the operator at the target site system.</li>
<li>Restores a library that contains an application</li>
<li>Copies the command to start the application in the QGPL library.</li>
</ul>
<p><strong>Note:</strong> The <samp>&amp;DEVICE</samp> parameter in the example
is the name of your media device. The <samp>&amp;SUCCESS</samp> parameter is used
as an indication of whether all licensed programs installed successfully.</p>
<pre>
PGM PARM(&amp;DEVICE &amp;SUCCESS)
DCL VAR(&amp;DEVICE) TYPE(*CHAR) LEN(10)
DCL VAR(&amp;SUCCESS) TYPE(*CHAR) LEN(1)
IF COND(&amp;SUCCESS *EQ '1') THEN(DO)
SNDUSRMSG MSG('Load the media into ' *CAT &amp;DEVICE *CAT 'and press the Enter key.')
RSTLIB SAVLIB(APP1) DEV(&amp;DEVICE)
CRTDUPOBJ OBJ(STRAPP1) FROMLIB(APP1) OBJTYPE(*CMD) TOLIB(QGPL)
ENDDO
ELSE
SNDUSRMSG MSG('One or more licensed programs failed to install.')
ENDPGM
</pre>
<p><img src="deltaend.gif" alt="End of change"></p>
<br>
<hr>
Exit program introduced: V2R3
<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=
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>