if_nameindex - Man Page

return all network interface names and indexes

Prolog

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.

Synopsis

#include <net/if.h>

struct if_nameindex *if_nameindex(void);

Description

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

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

Errors

The if_nameindex() function may fail if:

ENOBUFS

Insufficient resources are available to complete the function.

The following sections are informative.

Examples

None.

Application Usage

None.

Rationale

None.

Future Directions

None.

See Also

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

The Base Definitions volume of POSIX.1-2017, <net_if.h>

Referenced By

if_freenameindex(3p), if_indextoname(3p), if_nametoindex(3p), net_if.h(0p).

2017 IEEE/The Open Group POSIX Programmer's Manual