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

92 lines
4.2 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>Registered Filter APIs</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!-- File restructured for V5R2 -->
<!-- 031111 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 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>
<h2>Registered Filter APIs</h2>
<p>A <strong>filter</strong> is a function you can use to assign events into
groups and to specify actions to take for each group. The registered filter
APIs allow a product to register a filter with the operating system. The
product can receive notification of events recorded in a data queue by using
the Send to Data Queue (SNDDTAQ) action of the Work with Filter Action Entry
(WRKFTRACNE) command.</p>
<p>A user filter is the filter defined by the network attributes for alert
filtering and by the system value for problem log filtering. A user filter and
a registered filter differ in their function and their notification record.
There can only be one user filter active at one time for each type of filter,
but there can be multiple registered filters active at one time. All actions
are active for a user filter, but only the SNDDTAQ action is active for a
registered filter.</p>
<p>A product can use registered filter APIs for the following purposes:</p>
<ul>
<li>To register multiple filters at the same time for each event type (alert or
problem log)</li>
<li>To deregister a filter when notifications from that filter are no longer
necessary</li>
<li>To retrieve all the filters that are registered</li>
</ul>
<p>The event notification record for a registered filter differs from
notification records for other types of filters. The registered notification
contains a common header for all events, as well as specific information based
on the type of event. The common header includes the name of the notification,
a function type, a format, the filter name and library, the group name, and a
timestamp. The specific information for the problem log includes the problem
ID, the last event logged, and the timestamp for the last event.</p>
<p>The registered filter APIs are:</p>
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- Updates made in this section *will* be overlaid by automated tools -->
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
<!--***************API BEGIN PASTE***************-->
<ul>
<li><A HREF="QNMDRGFN.htm">Deregister Filter Notifications</A> (QNMDRGFN) deregisters a filter. If the identified filter is not currently registered, an error is returned.</li>
<li><A HREF="QNMRGFN.htm">Register Filter Notifications</A> (QNMRGFN) registers a filter to send notifications for a specific event to a data queue.</li>
<li><A HREF="QNMRRGF.htm">Retrieve Registered Filters</A> (QNMRRGF) returns all filters registered for a filter type.</li>
</ul>
<!--***************API END PASTE***************-->
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="netmg.htm">Network Management APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>