188 lines
5.9 KiB
HTML
188 lines
5.9 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>Replace Command Exit Program (QCARPLCM) 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. -->
|
||
|
|
<!-- QCARP450 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
|
||
|
|
<!-- at RCHVMW2 on 28 Sep 1999 at 14:40:31 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Edited by Kersten Feb 02 -->
|
||
|
|
<!--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>Replace Command Exit Program (QCARPLCM) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
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%">Change command exit information</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Replacement command</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Length of replacement command string</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Replace Command Exit Program (QCARPLCM) API may be used as the exit
|
||
|
|
program for the QIBM_QCA_CHG_COMMAND for any command. If the original command
|
||
|
|
was library-qualified with *SYSTEM or *NLVLIBL, the library qualifier will be
|
||
|
|
replaced with *LIBL. None of the parameter values specified on the original
|
||
|
|
command will be changed. See the <a href="xcachg.htm#HDRCACHGX">Command
|
||
|
|
Analyzer Change</a> exit program for a description of the QIBM_QCA_CHG_COMMAND
|
||
|
|
exit point.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>None</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Change command exit information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>Information about the command that the command analyzer was called to
|
||
|
|
process. See <a href="xcachg.htm#HDRCACXIN">Format CHGC0100</a> in the Command
|
||
|
|
Analyzer Change exit program.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Replacement command</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>A string containing the command string that is to be substituted for the one
|
||
|
|
that the command analyzer was called to process. If the original command was
|
||
|
|
library-qualified with *SYSTEM or *NLVLIBL, the library qualifer will be
|
||
|
|
replaced with *LIBL. None of the parameter values specified on the original
|
||
|
|
command will be changed. The maximum length of the changed command string is
|
||
|
|
32000 bytes.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of replacement command string</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the replacement command string (0 - 32000) in bytes.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<p><strong>Registration Considerations</strong></p>
|
||
|
|
|
||
|
|
<p>Use the Add Exit Program command (ADDEXITPGM) or API (QUSADDEP,
|
||
|
|
QusAddExitProgram) to register this program as an exit program for a command.
|
||
|
|
You must specify 20 bytes of exit program data. The first 10 characters specify
|
||
|
|
the command name; the second 10 characters specify the library name. For
|
||
|
|
example, to register QCARPLCM as the exit program to be called at the
|
||
|
|
QIBM_QCA_CHG_COMMAND exit point for the Display Job (DSPJOB) command in library
|
||
|
|
QSYS, specify:</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
ADDEXITPGM EXITPNT(QIBM_QCA_CHG_COMMAND)
|
||
|
|
FORMAT(CHGC0100)
|
||
|
|
PGMNBR(*LOW)
|
||
|
|
PGMDTA(*JOB 20 'DSPJOB QSYS ')
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<p>If you register QCARPLCM as an exit program for a command in library QSYS,
|
||
|
|
it also will be called for commands in the secondary language libraries. For
|
||
|
|
example, if the exit program is registered for the DSPJOB command in library
|
||
|
|
QSYS, it also will be called for the DSPJOB command in library QSYS2962.</p>
|
||
|
|
|
||
|
|
<p>If you rename the command or the library or move the command to another
|
||
|
|
library, you also must have the exit program registered using the new command
|
||
|
|
and library names.</p>
|
||
|
|
|
||
|
|
<p>If you register QCARPLCM as the exit program for a command, you cannot
|
||
|
|
register another exit program for the command for the QIBM_QCA_CHG_COMMAND exit
|
||
|
|
point.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<p><strong>Runtime Considerations</strong></p>
|
||
|
|
|
||
|
|
<p>If two applications on the same system need to replace the same command with
|
||
|
|
one of the same name but in different libraries, they can register QCARPLCM as
|
||
|
|
the exit program for the QIBM_QCA_CHG_COMMAND exit point for the command. The
|
||
|
|
applications must ensure that the correct application library is at the
|
||
|
|
beginning of the system part of the library list.</p>
|
||
|
|
|
||
|
|
<p>If the original command was library-qualified with a specific library name,
|
||
|
|
the exit program will not be allowed to change the command string, so the
|
||
|
|
command analyzer will search only the specified library for the command.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R5
|
||
|
|
|
||
|
|
<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=
|
||
|
|
"pgm1.htm">Program and CL Command APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|