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

264 lines
8.3 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>Default Handling 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 ========================================== -->
<!-- MH1TEMP SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 26 Jan 1999 at 10:37:34 -->
<!--File Edited Oct 2001 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Default Handling Exit Program</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;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%">Receiving program 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">Message key</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;QSYSINC Member Name: EMHDFTPG<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Default Handling exit program provides a default message handling action
that can be used if the program to which an escape message is sent does not
monitor for the message. Additional information and an example are provided in
the <a href="../rbam6/clpro.htm">CL Programming</a> topic. A default handling program is defined
to the system through the Add Message Description (ADDMSGD) command and the
Change Message Description (CHGMSGD) command.</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>Required Parameter Group</h3>
<dl>
<dt><strong>Receiving program information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The name of the call message queue to which the message was sent (this name
is the same name as that of the program that did not monitor for the escape
message). The structure for this parameter is described in <a href=
"#HDRRPIFORM">Format for Receiving Program Information</a>.</p>
</dd>
<dt><strong>Message key</strong></dt>
<dd>INPUT; CHAR(4)
<p>The message reference key of the escape message on the call message
queue.</p>
</dd>
</dl>
<br>
<h3><a name="HDRRPIFORM">Format for Receiving Program Information</a></h3>
<p>For detailed descriptions of each field, see the <a href="#HDRRCVRPI">Field
Descriptions</a>.</p>
<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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Receiving program name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Receiving module name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(256)</td>
<td align="left" valign="top">Receiving procedure name</td>
</tr>
<tr>
<td align="center" valign="top">276</td>
<td align="center" valign="top">114</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Receiving program type</td>
</tr>
<tr>
<td align="center" valign="top">277</td>
<td align="center" valign="top">115</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">280</td>
<td align="center" valign="top">118</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to long receiving procedure name</td>
</tr>
<tr>
<td align="center" valign="top">284</td>
<td align="center" valign="top">11C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of long receiving procedure name</td>
</tr>
<tr>
<td align="center" valign="top">288</td>
<td align="center" valign="top">120</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2">The offset to this field is found in
the offset field identified above.</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Long receiving procedure name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRCVRPI">Field Descriptions</a></h3>
<p><strong>Length of long receiving procedure name.</strong> For receiving
program types 1 and 2, the length of the receiving procedure name, in
bytes.</p>
<p><strong>Long receiving procedure name.</strong> For receiving program types
1 and 2, the complete procedure name that did not monitor for the message. A
nested procedure name has each procedure name separated by a colon. The
outermost procedure name is identified first followed by its contained
procedures. The innermost procedure is identified last in the string.</p>
<p><strong>Offset to long receiving procedure name.</strong> When the receiving
program type is 1 or 2, the offset to the long receiving procedure name, in
bytes, from the beginning of this parameter structure.</p>
<p><strong>Receiving module name.</strong> For receiving program types 1 and 2,
the name of the module that did not monitor for the message. For type 0, this
field contains blanks.</p>
<p><strong>Receiving procedure name.</strong> For receiving program type 1, the
name of the procedure that did not monitor for the message. A nested procedure
name has each procedure name separated by a colon. The outermost procedure name
is identified first followed by its contained procedures. The innermost
procedure is identified last in the string. For types 0 and 2, this field
contains blanks.</p>
<p><strong>Receiving program name.</strong> The name of the program that did
not monitor for the message.</p>
<p><strong>Receiving program type.</strong> The type of program that received
the message (that is, that did not monitor for the message). Valid values
follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The message was sent to an OPM program.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The message was sent to a procedure within an ILE
program, and the procedure name is 256 characters or less.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The message was sent to a procedure within an ILE
program, and the procedure name is from 257 through 4096 characters. For this
type, the receiving procedure name is blank, and the name can be obtained from
the long receiving procedure name.</td>
</tr>
</table>
<p><strong>Reserved.</strong> An ignored field.</p>
<br>
<h3>Usage Notes</h3>
<p>This exit program could be called from an exit point within a multithreaded
job and should be written to be threadsafe.</p>
<hr>
Exit program introduced: V3R6
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"mh1.htm">Message Handling APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>