if_nameindex(3p) — Linux manual page

IF_NAMEINDEX(3P)        POSIX Programmer's Manual       IF_NAMEINDEX(3P)

PROLOG         top

       This manual page is part of the POSIX Programmer's Manual.  The
       Linux implementation of this interface may differ (consult the
       corresponding Linux manual page for details of Linux behavior),
       or the interface may not be implemented on Linux.

NAME         top

       if_nameindex — return all network interface names and indexes

SYNOPSIS         top

       #include <net/if.h>

       struct if_nameindex *if_nameindex(void);

DESCRIPTION         top

       The if_nameindex() function shall return an array of if_nameindex
       structures, one structure per interface. The end of the array is
       indicated by a structure with an if_index field of zero and an
       if_name field of NULL.

       Applications should call if_freenameindex() to release the memory
       that may be dynamically allocated by this function, after they
       have finished using it.

RETURN VALUE         top

       An array of structures identifying local interfaces. A null
       pointer is returned upon an error, with errno set to indicate the
       error.

ERRORS         top

       The if_nameindex() function may fail if:

       ENOBUFS
              Insufficient resources are available to complete the
              function.

       The following sections are informative.

EXAMPLES         top

       None.

APPLICATION USAGE         top

       None.

RATIONALE         top

       None.

FUTURE DIRECTIONS         top

       None.

SEE ALSO         top

       getsockopt(3p), if_freenameindex(3p), if_indextoname(3p),
       if_nametoindex(3p), setsockopt(3p)

       The Base Definitions volume of POSIX.1‐2017, net_if.h(0p)

COPYRIGHT         top

       Portions of this text are reprinted and reproduced in electronic
       form from IEEE Std 1003.1-2017, Standard for Information
       Technology -- Portable Operating System Interface (POSIX), The
       Open Group Base Specifications Issue 7, 2018 Edition, Copyright
       (C) 2018 by the Institute of Electrical and Electronics
       Engineers, Inc and The Open Group.  In the event of any
       discrepancy between this version and the original IEEE and The
       Open Group Standard, the original IEEE and The Open Group
       Standard is the referee document. The original Standard can be
       obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page
       are most likely to have been introduced during the conversion of
       the source files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE/The Open Group               2017                  IF_NAMEINDEX(3P)

Pages that refer to this page: net_if.h(0p),  if_freenameindex(3p),  if_indextoname(3p),  if_nametoindex(3p)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.