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

215 lines
5.9 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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 ARP Table Entry (QtocRmvARPTblE) 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. -->
<!-- COMM4 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
<!-- RCHVMW2 on 1 Jun 1999 at 17:32:50 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited December, 2001 =========================================== -->
<!--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 ARP Table Entry (QtocRmvARPTblE) API</h2>
<div class="box" style="width: 60%;">
&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%">Line name</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">Internet address</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Entry type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">4</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: QTOCNETSTS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove ARP Table Entry (QtocRmvARPTblE) API removes one or all dynamic entries from the ARP (Address Resolution Protocol) table for the specified line. Local interface entries cannot be removed.</p>
<p>TCP/IP must be active on this system; otherwise, error message TCP84C0 is issued.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Special Authority</em></dt>
<dd>*IOSYSCFG</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Line name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the physical interface corresponding to the ARP table from which to remove entries.</p></dd>
<dt><strong>Internet address</strong></dt>
<dd>INPUT; BINARY(4)
<p>The IP address of the entry to remove from the ARP table. This must be 0 when trying to remove all dynamic ARP entries.</p></dd>
<dt><strong>Entry type</strong></dt>
<dd>INPUT; CHAR(10)
<p>Whether a single entry or all entries are removed from the ARP table. The possible types are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*IPADDR</em></td>
<td valign="top">The Internet address field corresponds to a single entry to be removed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td valign="top">The Internet address field must be 0 and all ARP table entries will be removed.</td>
</tr>
</table>
<br>
</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="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">TCP84C0 E</td>
<td valign="top">TCP/IP stack not active.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C1 E</td>
<td valign="top">The specified Internet address was not found in the ARP table.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C2 E</td>
<td valign="top">ARP entry is local and cannot be deleted.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C3 E</td>
<td valign="top">The specified line name does not exist.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C4 E</td>
<td valign="top">The specified line name corresponds to a line type that does not support ARP.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C6 E</td>
<td valign="top">Internal operations error.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C8 E</td>
<td valign="top">ARP API parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center"><td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a>
| <a href="comm.htm">Communications APIs</a>
| <a href="aplist.htm">APIs by category</a>
</td>
</tr>
</table>
</center>
</body>
</html>