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

129 lines
3.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>fDPIparse()--Free Storage from DPI Packet Parse</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. -->
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--End Header Records --><!-- Edited by Kersten Feb 02 -->
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>fDPIparse()--Free Storage from DPI Packet Parse</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;qtossapi.h&gt;
void fDPIparse( snmp_dpi_hdr <em>*hdr_p</em> );
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QTOSSAPI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>fDPIparse()</strong> function frees storage that was previously
allocated by a call to <strong>pDPIpacket()</strong> to store the DPI
packet.</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>Parameters</h3>
<dl>
<dt><strong>hdr_p</strong></dt>
<dd>(Input) A pointer to an snmp_dpi_hdr structure.</dd>
</dl>
<br>
<h3>Usage Notes</h3>
<p>The <strong>fDPIparse()</strong> function frees dynamic storage that was
previously created by a call to <strong>pDPIpacket()</strong>. After calling
<strong>fDPIparse()</strong>, no further references should be made to hdr_p,
which pointed to the snmp_dpi_hdr structure.</p>
<p>A complete or partial DPI snmp_dpi_hdr structure is also implicitly freed by
a call to a DPI function that serializes an snmp_dpi_hdr structure into a DPI
packet. The section that describes each function tells you if this is the case.
An example of such a function is <strong>mkDPIresponse()</strong>.</p>
<br>
<h3>Related Information</h3>
<ul>
<li>The &lt;<strong>qtossapi.h</strong>&gt; file (see <a href="unix13.htm">Header
Files for UNIX-Type Functions</a>)<br>
<br>
</li>
<li><a href="respsnmp.htm">mkDPIresponse()</a>--Make a DPI Response Packet<br>
<br>
</li>
<li><a href="ppacsnmp.htm">pDPIpacket()</a>--Parse a 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 &lt;qtossapi.h&gt;
snmp_dpi_hdr *hdr_p;
unsigned char *pack_p; /* Assume pack_p points to */
/* incoming DPI packet. */
hdr_p = pDPIpacket(pack_p);
/* Handle the packet, and when done, do the following. */
if (hdr_p) fDPIparse(hdr_p);
</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>