222 lines
6.3 KiB
HTML
222 lines
6.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">
|
||
|
|
<!-- 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. -->
|
||
|
|
<!-- Created for V5R4 by Sergio Toscano (stlomeli) D99930.1 -->
|
||
|
|
<!-- Reason vXrYmZ Dev Date Change -->
|
||
|
|
<!-- d3602 v5r4m0 Sergio Toscano 040905 + Add CPF39EC msg -->
|
||
|
|
<!-- + Add CPF9872, CPF24B4, -->
|
||
|
|
<!-- CPF3CF1 msgs -->
|
||
|
|
<title>End Watch (QSCEWCH) API</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!--End Header Records ================================================ -->
|
||
|
|
<!-- 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">End Watch (QSCEWCH) 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%">Session ID</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">Error Code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *EXCLUDE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The End Watch (QSCEWCH) API ends a watch session that was started
|
||
|
|
by a STRWCH (Start Watch) command or by the Start Watch (QSCSWCH) API. </p>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> A watch session can be ended from the same job that issued the start
|
||
|
|
function or from a different job.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Authority to use the API</em></dt>
|
||
|
|
|
||
|
|
<dd>To use this API, you must have service (*SERVICE) special authority,
|
||
|
|
or be authorized to the Service watch function of Operating System
|
||
|
|
through iSeries Navigator's Application Administration support.
|
||
|
|
The Change Function Usage (CHGFCNUSG) command, with a
|
||
|
|
function ID of QIBM_SERVICE_WATCH, can also be used to
|
||
|
|
change the list of users that are allowed to start and end watch
|
||
|
|
operations. <br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Authority to watch session</em></dt>
|
||
|
|
|
||
|
|
<dd>If ending a watch session that is watching for a message within a job log, the issuer
|
||
|
|
of the API must be running under a user profile which is the same as the job user identity of
|
||
|
|
the job being watched, or the issuer of the API must be running under a user profile which
|
||
|
|
has job control (*JOBCTL) special authority. Job control (*JOBCTL) special authority is also
|
||
|
|
required when ending a session where jobs with a generic user name are being watched.
|
||
|
|
|
||
|
|
<p>If ending a watch session that was started specifying *ALL for the watch job name, or a
|
||
|
|
generic user name, you must have *ALLOBJ special authority, or be authorized to the Watch any
|
||
|
|
job function of Operating System through iSeries Navigator's Application Administration support.
|
||
|
|
The Change Function Usage (CHGFCNUSG) command, with a function ID of QIBM_WATCH_ANY_JOB, can also
|
||
|
|
be used to change the list of users that are allowed to start and end watch operations.</p>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Session ID</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The session identifier for the watch to be ended.
|
||
|
|
This name must match the session identifier of a watch that had been
|
||
|
|
previously started and is still active.
|
||
|
|
You can use this special value for this parameter:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="10 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*PRV</em></td>
|
||
|
|
<td align="left" valign="top">The watch session most recently started by the same user who is
|
||
|
|
running this API will be ended. For example, if the job
|
||
|
|
running the API is running under user profile BOB, the last
|
||
|
|
watch session started under user profile BOB is ended.
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="header_9">Error Messages</a></h3>
|
||
|
|
|
||
|
|
<p>The following messages may be sent from this function:</p>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF24B4</td>
|
||
|
|
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF39EC</td>
|
||
|
|
<td valign="top">Cannot end watch session &1 started by &2 command.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF39E1</td>
|
||
|
|
<td width="85%" valign="top">Watch session ID &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF39E2</td>
|
||
|
|
<td valign="top">There is not any active watch session for current user profile.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF39E6</td>
|
||
|
|
<td valign="top">The user does not have the required authority.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF39E8</td>
|
||
|
|
<td valign="top">Not enough authority to watch operations.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF39E9</td>
|
||
|
|
<td valign="top">*JOBCTL special authority required.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<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>
|