m2iplib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_m2Lib_INVALID_PARAMETER</b><br>
&nbsp;<b>S_m2Lib_INVALID_VAR_TO_SET</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpAddrTblEntryGet">m2IpAddrTblEntryGet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAtransTblEntrySet">m2IpAtransTblEntrySet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpDelete">m2IpDelete</a>(&nbsp;)</b>

<hr>
<a name="m2IpAddrTblEntryGet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>m2IpAddrTblEntryGet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>m2IpAddrTblEntryGet(&nbsp;)</strong> - get an IP MIB-II address entry</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS m2IpAddrTblEntryGet
    (
    int            search,         /* M2_EXACT_VALUE or M2_NEXT_VALUE */
    M2_IPADDRTBL * pIpAddrTblEntry /* ptr to requested IP address entry */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine traverses the IP address table and does an <b>M2_EXACT_VALUE</b> or
a <b>M2_NEXT_VALUE</b> search based on the <i>search</i> parameter.  The calling 
routine is responsible for supplying a valid MIB-II entry index in the
input structure <i>pIpAddrTblEntry</i>.  The index is the local IP
address. The first entry in the table is retrieved by doing a NEXT search
with the index field set to zero. 
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
OK, ERROR if the input parameter is not specified, or a match is not found.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_m2Lib_INVALID_PARAMETER</b><br>
&nbsp;<b>S_m2Lib_ENTRY_NOT_FOUND</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2Lib.html#top">m2Lib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoSet">m2IpGroupInfoSet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAtransTblEntrySet">m2IpAtransTblEntrySet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpDelete">m2IpDelete</a>(&nbsp;)</b>

<hr>
<a name="m2IpAtransTblEntryGet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>m2IpAtransTblEntryGet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>m2IpAtransTblEntryGet(&nbsp;)</strong> - get a MIB-II ARP table entry</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS m2IpAtransTblEntryGet
    (
    int              search,       /* M2_EXACT_VALUE or M2_NEXT_VALUE */
    M2_IPATRANSTBL * pReqIpAtEntry /* ptr to the requested ARP entry */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine traverses the ARP table and does an <b>M2_EXACT_VALUE</b> or a
<b>M2_NEXT_VALUE</b> search based on the <i>search</i> parameter.  The calling 
routine is responsible for supplying a valid MIB-II entry index in the 
input structure <i>pReqIpatEntry</i>.  The index is made up of the network
interface index and the IP address corresponding to the physical address.
The first entry in the table is retrieved by doing a NEXT search with the
index fields set to zero. 
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
OK, ERROR if the input parameter is not specified, or a match is not found.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_m2Lib_INVALID_PARAMETER</b><br>
&nbsp;<b>S_m2Lib_ENTRY_NOT_FOUND</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2Lib.html#top">m2Lib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoSet">m2IpGroupInfoSet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAtransTblEntrySet">m2IpAtransTblEntrySet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpDelete">m2IpDelete</a>(&nbsp;)</b>

<hr>
<a name="m2IpAtransTblEntrySet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>m2IpAtransTblEntrySet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>m2IpAtransTblEntrySet(&nbsp;)</strong> - add, modify, or delete a MIB-II ARP entry</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS m2IpAtransTblEntrySet
    (
    M2_IPATRANSTBL * pReqIpAtEntry /* pointer to MIB-II ARP entry */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine traverses the ARP table for the entry specified in the parameter
<i>pReqIpAtEntry</i>.  An ARP entry can be added, modified, or deleted.  A  MIB-II
entry index is specified by the destination IP address and the physical media
address.  A new ARP entry can be added by specifying all the fields in the
parameter <i>pReqIpAtEntry</i>. An entry can be modified by specifying the MIB-II
index and the field that is to be modified.  An entry is deleted by 
specifying the index and setting the type field in the input parameter 
<i>pReqIpAtEntry</i> to the MIB-II value "invalid" (2).
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
<p>
OK, or ERROR if the input parameter is not specified, the physical address
is not specified for an add/modify request, or the <b><a href="./ioLib.html#ioctl">ioctl</a>(&nbsp;)</b> request to the ARP
module fails.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_m2Lib_INVALID_PARAMETER</b><br>
&nbsp;<b>S_m2Lib_ARP_PHYSADDR_NOT_SPECIFIED</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoSet">m2IpGroupInfoSet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAddrTblEntryGet">m2IpAddrTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpDelete">m2IpDelete</a>(&nbsp;)</b>

<hr>
<a name="m2IpRouteTblEntryGet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>m2IpRouteTblEntryGet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>m2IpRouteTblEntryGet(&nbsp;)</strong> - get a MIB-2 routing table entry </p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS m2IpRouteTblEntryGet
    (
    int             search,          /* M2_EXACT_VALUE or M2_NEXT_VALUE */
    M2_IPROUTETBL * pIpRouteTblEntry /* route table entry */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine retrieves MIB-II information about an entry in 
the network routing table and returns it in the caller-supplied structure 
<i>pIpRouteTblEntry</i>.  
<p>
The routine compares routing table entries to the address specified by the
<b>ipRouteDest</b> member of the <i>pIpRouteTblEntry</i> structure, and retrieves an
entry chosen by the <i>search</i> type (<b>M2_EXACT_VALUE</b> or <b>M2_NEXT_VALUE</b>, as
described in the manual entry for <b><a href="./m2Lib.html#top">m2Lib</a></b>).
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK if successful, otherwise ERROR.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;&nbsp;<b>S_m2Lib_INVALID_PARAMETER</b>&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;<b>S_m2Lib_ENTRY_NOT_FOUND</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2Lib.html#top">m2Lib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoSet">m2IpGroupInfoSet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAddrTblEntryGet">m2IpAddrTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpDelete">m2IpDelete</a>(&nbsp;)</b>

<hr>
<a name="m2IpRouteTblEntrySet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>m2IpRouteTblEntrySet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>m2IpRouteTblEntrySet(&nbsp;)</strong> - set a MIB-II routing table entry</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS m2IpRouteTblEntrySet
    (
    int             varToSet,        /* variable to set */
    M2_IPROUTETBL * pIpRouteTblEntry /* route table entry */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine adds, changes, or deletes a network routing table entry.  
The table entry to be modified is specified by the <b>ipRouteDest</b> and
<b>ipRouteNextHop</b> members of the <i>pIpRouteTblEntry</i> structure.
<p>
The <i>varToSet</i> parameter is a bit-field mask that specifies which values
in the route table entry are to be set.
<p>
If <i>varToSet</i> has the <b>M2_IP_ROUTE_TYPE</b> bit set and <b>ipRouteType</b> has the
value of <b>M2_ROUTE_TYPE_INVALID</b>, then the the routing table entry is
deleted.
<p>
If <i>varToSet</i> has the either the <b>M2_IP_ROUTE_DEST</b>, <b>M2_IP_ROUTE_NEXT_HOP</b>
and the <b>M2_IP_ROUTE_MASK</b> bits set, then a new route entry is added 
to the table. 
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK if successful, otherwise ERROR.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoSet">m2IpGroupInfoSet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAddrTblEntryGet">m2IpAddrTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpDelete">m2IpDelete</a>(&nbsp;)</b>

<hr>
<a name="m2IpDelete"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>m2IpDelete(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>m2IpDelete(&nbsp;)</strong> - delete all resources used to access the IP group</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS m2IpDelete (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine frees all the resources allocated when the IP group was
initialized.  The IP group should not be accessed after this routine has been
called.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, always.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./m2IpLib.html#top">m2IpLib</a></b>, <b><a href="./m2IpLib.html#m2IpInit">m2IpInit</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoGet">m2IpGroupInfoGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpGroupInfoSet">m2IpGroupInfoSet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpAddrTblEntryGet">m2IpAddrTblEntryGet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpAtransTblEntrySet">m2IpAtransTblEntrySet</a>(&nbsp;)</b>, <b><a href="./m2IpLib.html#m2IpRouteTblEntryGet">m2IpRouteTblEntryGet</a>(&nbsp;)</b>,  
<b><a href="./m2IpLib.html#m2IpRouteTblEntrySet">m2IpRouteTblEntrySet</a>(&nbsp;)</b>

</body>
</html>