friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qypsrcno.htm

390 lines
8.4 KiB
HTML
Raw Blame History

<!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>Remove Collector Notification (QypsRmvCollectorNotification) 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. -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- created by janet brauckman on 23 nov 1999 -->
<!-- edited by Kersten Feb 2002 -->
<!-- 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>Remove Collector Notification (QypsRmvCollectorNotification) API</h2>
<div class="box" style="width: 80%;">
<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%">Collector name</td>
<td align="left" valign="top" width="20%">I</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">Qualified data queue name</td>
<td align="left" valign="top">I</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Notification type</td>
<td align="left" valign="top">I</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Category list</td>
<td align="left" valign="top">I</td>
<td align="left" valign="top">Array of Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Category count</td>
<td align="left" valign="top">I</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</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>
&nbsp;&nbsp;Service Program Name: QYPSCOLL<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove Collector Notification (QypsRmvCollectorNotification) API removes
a notification registration from a collector for a specified data queue and
collection event. A collection event occurs when:</p>
<ul>
<li>The collector cycle interval is reached.</li>
<li>The collector is ended or stopped.</li>
<li>The default data collection interval is reached.</li>
<li>The category data collection interval is reached.</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE<br>
<br>
</dd>
<dt><em>Data Queue Authority</em></dt>
<dd>*CHANGE<br>
<br>
</dd>
<dt><em>Library Authority</em></dt>
<dd>*EXECUTE<br>
<br>
</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Collector name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the collector that is removing notification. One of these
special values must be used:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*PFR</em></td>
<td align="left" valign="top">Performance Collector</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified data queue name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The data queue from which the notification is to be removed. The first ten
characters contain the data queue name, and the second ten characters contain
the data queue library name. The data queue must already exist. You can use
these special values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Notification type</strong></dt>
<dd>INPUT; BINARY(4)
<p>The type of event notification to remove:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Collector - remove the cycle, end, and interval
notifications.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Cycle - remove the collection cycle event
notification.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">End - remove notification of the end event.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Interval - remove notification of the default
collection interval event.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Category - remove notification for the category
event.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Category list</strong></dt>
<dd>INPUT; ARRAY OF CHAR(10)
<p>List of category names, for which notification is to be removed. This field
is only applicable when Notification type is set to category notification (4).
Category name can be a system-defined category name or a user-defined category
name.</p>
</dd>
<dt><strong>System-defined category name</strong></dt>
<dd>A 10 character name of a system-defined category. For the *PFR collector
system-defined categories are:<br>
<br>
<ul>
<li>*APPN
</li>
<li>*CMNBASE
</li>
<li>*CMNSAP
</li>
<li>*CMNSTN
</li>
<li>*DISK
</li>
<li>*HDWCFG
</li>
<li>*IOPBASE
</li>
<li>*IPCS
</li>
<li>*JOBMI
</li>
<li>*JOBOS
</li>
<li>*LCLRSP
</li>
<li>*POOL
</li>
<li>*POOLTUNE
</li>
<li>*SNA
</li>
<li>*SNADS
</li>
<li>*SUBSYSTEM
</li>
<li>*SYSBUS
</li>
<li>*SYSCPU
</li>
<li>*SYSLVL
</li>
<li>*TCPBASE
</li>
<li>*TCPIFC
</li>
<li>*USRTNS
</li>
</ul>
<br>
<br>
</dd>
<dt><strong>Registered user-defined category name</strong></dt>
<dd>A 10 character name of a user-defined category registered by the Register
Collector Data Category (QypsRegCollectorDataCategory) API.<br>
<br>
</dd>
<dt><strong>Category count</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of categories entered in input field Category list. This field is
only applicable when Notification type is set to category notification (4).
Category count must have a value of '0' when Notification type is not a
category notification (4).</p>
</dd>
<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>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<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">CPF3C1E E</td>
<td width="85%" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB94A E</td>
<td align="left" valign="top">Collector communications error. Reason code
&amp;1.</td>
</tr>
</table>
<br>
<br>
<hr>
API introduced: V5R2
<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=
"perfmgmt.htm">Performance Management</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink