163 lines
4.8 KiB
HTML
163 lines
4.8 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>mkDPIunregister()--Make a DPI Unregister Packet</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 ========================================== -->
|
||
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!--End Header Records -->
|
||
|
|
<!-- Edited by Kersten Feb 02 -->
|
||
|
|
<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>mkDPIunregister()--Make a DPI Unregister Packet</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 50%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <qtossapi.h>
|
||
|
|
|
||
|
|
unsigned char *mkDPIunregister(
|
||
|
|
char <em>reason_code</em>,
|
||
|
|
char <em>*group_p</em>);
|
||
|
|
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Service Program Name: QTOSSAPI<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>mkDPIunregister()</strong> function makes a DPI unregister
|
||
|
|
packet and returns a pointer to the packet.</p>
|
||
|
|
|
||
|
|
<!-- 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>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>reason_code</strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) The reason for the unregister operation. See the
|
||
|
|
<strong><qtossapi.h></strong> file for a list of defined reason
|
||
|
|
codes.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>group_p</strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) A pointer to a NULL-terminated character string that represents the
|
||
|
|
subtree to be unregistered. The subtree must have a trailing dot.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>pointer value</em></td>
|
||
|
|
<td align="left" valign="top">The <strong>mkDPIunregister()</strong> function
|
||
|
|
was successful. The value returned is a pointer to the DPI packet.
|
||
|
|
|
||
|
|
<p>If successful, then a pointer to a static DPI packet buffer is returned. The
|
||
|
|
first 2 bytes of the buffer (in network byte order) contain the length of the
|
||
|
|
remaining packet. The <strong>DPI_PACKET_LEN()</strong> function can be used to
|
||
|
|
calculate the total length of the DPI packet.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>NULL</em></td>
|
||
|
|
<td align="left" valign="top">The <strong>mkDPIunregister()</strong> function
|
||
|
|
was not successful.
|
||
|
|
|
||
|
|
<p>If unsuccessful, then a NULL pointer is returned.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>Be aware that the static buffer for the DPI packet is shared by other
|
||
|
|
mkDPI<em>xxxx</em>() functions that create a serialized DPI packet.</p>
|
||
|
|
|
||
|
|
<p>For more information, see "SNMP Subagent Problem Determination" in the <a
|
||
|
|
href="../books/sc415412.pdf" target="_blank">Simple Network Management
|
||
|
|
Protocol</a> <img src="wbpdf.gif" alt="Link to PDF"> book.</p>
|
||
|
|
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<p>The <strong>mkDPIunregister()</strong> function creates a serialized DPI
|
||
|
|
UNREGISTER packet that can then be sent to the SNMP agent. Normally, the SNMP
|
||
|
|
peer then sends a DPI RESPONSE packet back, which details if the unregister was
|
||
|
|
successful or not.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Related Information</h3>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>The <<strong>qtossapi.h</strong>> file (see <a href="unix13.htm">Header
|
||
|
|
Files for UNIX-Type Functions</a>)<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li><a href="dlensnmp.htm">DPI_PACKET_LEN()</a>--Get Length of DPI Packet</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Example</h3>
|
||
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
||
|
|
for information pertaining to code examples.</p>
|
||
|
|
<pre>
|
||
|
|
#include <qtossapi.h>
|
||
|
|
unsigned char *pack_p;
|
||
|
|
|
||
|
|
pack_p = mkDPIunregister(
|
||
|
|
SNMP_UNREGISTER_goingDown,
|
||
|
|
"1.3.6.1.2.3.4.5.");
|
||
|
|
if (pack_p) {
|
||
|
|
/* Send packet to agent or subagent and await response. */
|
||
|
|
}
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API 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="unix.htm">UNIX-Type APIs</a> |
|
||
|
|
<a href="aplist.htm">APIs by category</a> </td>
|
||
|
|
</tr>
|
||
|
|
</table></center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|