193 lines
6.0 KiB
HTML
193 lines
6.0 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<!-- Begin Header records -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Start Watch Command or API Exit Program (QPDETWCH) API</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. -->
|
|
<!-- Created for VxRy on YYMMDD by INITIALS -->
|
|
<!-- Change history: -->
|
|
<!-- 050111 RBS Created new -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<!-- Java sync-link -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2><img src="delta.gif" alt="Start of change">Start Watch Command or API Exit Program (QPDETWCH) API</h2>
|
|
|
|
<div class="box" style="width: 90%;">
|
|
<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%">Watch option setting</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">2</td>
|
|
<td align="left" valign="top">Session ID</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Error detected</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Event data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
QSYSINC Member Name: <br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Exit Point Name: QPDETWCH <br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Exit Point Format Name: QPDETWCH <br>
|
|
<!-- iddvc RMBR -->
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Start Watch Command or API Exit Program (QPDETWCH) API can be used as the
|
|
exit program for the Start Watch (STRWCH) Command or Start Watch (QSCSWCH) API. See the online help for more
|
|
information about the STRWCH command, or
|
|
refer to the <a href="qscswch.htm">Start Watch (QSCSWCH)</a> API.</p>
|
|
|
|
<p>This program takes the information supplied by the Start Watch Command or API,
|
|
generates an XML service request, and places that service request on the Service Monitor queue.</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>Watch option setting</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The reason indicating why the exit program was called.</p>
|
|
<p>The possible values are:</p>
|
|
|
|
<table width="100%">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="center" valign="top" width="20%">*MSGID</td>
|
|
<td align="left" valign="top" width="80%">A match on a message id and any associated
|
|
comparison data specified on watch for message parameter occurred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">*LICLOG</td>
|
|
<td align="left" valign="top">A match on a LIC log and any associated comparison data
|
|
specified on the watch for LIC log entry parameter occurred.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</dd>
|
|
|
|
<dt><strong>Session ID</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the session that is calling the exit program.</p>
|
|
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable </strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable described in Format of data returned. If the length
|
|
is larger than the size of the receiver variable, the results may not be predictable. The minimum
|
|
length is 8 bytes.</p>
|
|
|
|
</dd>
|
|
|
|
<dt><strong>Error detected </strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(10)
|
|
|
|
<p>Indicates if an error in the exit program was found. </p>
|
|
<p>The possible values are:</p>
|
|
<table width="100%">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="center" valign="top" width="20%">*ERROR</td>
|
|
<td align="left" valign="top" width="80%">Error detected by watch exit program. The watch session
|
|
that was passed in Session ID parameter will be ended. If the watch session to be ended originally
|
|
specified multiple message ids or LIC log entries, all of them will no longer be watched.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"><blanks></td>
|
|
<td align="left" valign="top">No error detected by watch exit program.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p><strong>Note: </strong>Any value other than "ERROR" or <blanks> will be considered
|
|
an error and the watch session that was passed in Session ID parameter will be ended. If the watch
|
|
session to be ended originally specified multiple message ids or LIC log entries, all of them will no
|
|
longer be watched.</p>
|
|
</dd>
|
|
<dt><strong>Event data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The format of the watch information depends on the Watch option setting causing the exit program
|
|
to be called.</p>
|
|
<p>Information about the format of the event data can be found in the Start Watch Exit Program
|
|
documentation.</p>
|
|
</dd>
|
|
|
|
</dl>
|
|
|
|
<br>
|
|
<img src="deltaend.gif" alt="End of change">
|
|
<hr>
|
|
API introduced: V5R4
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"pm1.htm">Problem Management APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|