if_nametoindex(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | STANDARDS | HISTORY | SEE ALSO | COLOPHON

if_nametoindex(3)       Library Functions Manual       if_nametoindex(3)

NAME         top

       if_nametoindex, if_indextoname - mappings between network
       interface names and indexes

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <net/if.h>

       unsigned int if_nametoindex(const char *ifname);
       char *if_indextoname(unsigned int ifindex, char *ifname);

DESCRIPTION         top

       The if_nametoindex() function returns the index of the network
       interface corresponding to the name ifname.

       The if_indextoname() function returns the name of the network
       interface corresponding to the interface index ifindex.  The name
       is placed in the buffer pointed to by ifname.  The buffer must
       allow for the storage of at least IF_NAMESIZE bytes.

RETURN VALUE         top

       On success, if_nametoindex() returns the index number of the
       network interface; on error, 0 is returned and errno is set to
       indicate the error.

       On success, if_indextoname() returns ifname; on error, NULL is
       returned and errno is set to indicate the error.

ERRORS         top

       if_nametoindex() may fail and set errno if:

       ENODEV No interface found with given name.

       if_indextoname() may fail and set errno if:

       ENXIO  No interface found for the index.

       if_nametoindex() and if_indextoname() may also fail for any of
       the errors specified for socket(2) or ioctl(2).

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           Attribute     Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ if_nametoindex(), if_indextoname()  │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       POSIX.1-2008, RFC 3493.

HISTORY         top

       POSIX.1-2001.  BSDi.

SEE ALSO         top

       getifaddrs(3), if_nameindex(3), ifconfig(8)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       [email protected]

Linux man-pages 6.9.1          2024-05-02              if_nametoindex(3)

Pages that refer to this page: if_nameindex(3)