man-pages/man3/if_nametoindex.3.html
2021-03-31 01:06:50 +01:00

182 lines
3.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of IF_NAMETOINDEX</TITLE>
</HEAD><BODY>
<H1>IF_NAMETOINDEX</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
if_nametoindex, if_indextoname - mappings between network interface
names and indexes
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/net/if.h">net/if.h</A>&gt;</B>
<B>unsigned int if_nametoindex(const char *</B><I>ifname</I><B>);</B>
<B>char *if_indextoname(unsigned int ifindex, char *</B><I>ifname</I><B>);</B>
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>if_nametoindex</B>()
function returns the index of the network interface
corresponding to the name
<I>ifname</I>.
<P>
The
<B>if_indextoname</B>()
function returns the name of the network interface
corresponding to the interface index
<I>ifindex</I>.
The name is placed in the buffer pointed to by
<I>ifname</I>.
The buffer must allow for the storage of at least
<B>IF_NAMESIZE</B>
bytes.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success,
<B>if_nametoindex</B>()
returns the index number of the network interface;
on error, 0 is returned and
<I>errno</I>
is set appropriately.
<P>
On success,
<B>if_indextoname</B>()
returns
<I>ifname</I>;
on error, NULL is returned and
<I>errno</I>
is set appropriately.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<B>if_nametoindex</B>()
may fail and set
<I>errno</I>
if:
<DL COMPACT>
<DT id="1"><B>ENODEV</B>
<DD>
No interface found with given name.
</DL>
<P>
<B>if_indextoname</B>()
may fail and set
<I>errno</I>
if:
<DL COMPACT>
<DT id="2"><B>ENXIO</B>
<DD>
No interface found for the index.
</DL>
<P>
<B>if_nametoindex</B>()
and
<B>if_indextoname</B>()
may also fail for any of the errors specified for
<B><A HREF="/cgi-bin/man/man2html?2+socket">socket</A></B>(2)
or
<B><A HREF="/cgi-bin/man/man2html?2+ioctl">ioctl</A></B>(2).
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>if_nametoindex</B>(),
<B>if_indextoname</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
POSIX.1-2001, POSIX.1-2008, RFC&nbsp;3493.
<P>
This function first appeared in BSDi.
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+getifaddrs">getifaddrs</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+if_nameindex">if_nameindex</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?8+ifconfig">ifconfig</A></B>(8)
<A NAME="lbAJ">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="3"><A HREF="#lbAB">NAME</A><DD>
<DT id="4"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="5"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="7"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="8"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="9"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="10"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="11"><A HREF="#lbAJ">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:46 GMT, March 31, 2021
</BODY>
</HTML>