NAME
if_nameindex —
return all network interface names and indexes
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(3) 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.
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
getsockopt(3) , if_freenameindex(3) , if_indextoname(3) , if_nametoindex(3) , setsockopt(3)
XBD <net/if.h>
CHANGE HISTORY
First released in Issue 6. Derived from the XNS, Issue 5.2 specification.