original/man3/if_nameindex.3

   1 .\" Copyright (c) 2012 YOSHIFUJI Hideaki <yoshfuji@linux-ipv6.org>
   2 .\" and Copyright (c) 2012 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of
  10 .\" this manual under the conditions for verbatim copying, provided that
  11 .\" the entire resulting derived work is distributed under the terms of
  12 .\" a permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume
  16 .\" no responsibility for errors or omissions, or for damages resulting
  17 .\" from the use of the information contained herein.  The author(s) may
  18 .\" not have taken the same level of care in the production of this
  19 .\" manual, which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH IF_NAMEINDEX 3 2012-11-21 "GNU" "Linux Programmer's Manual"
  27 .SH NAME
  28 if_nameindex, if_freenameindex \- get network interface names and indexes
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <net/if.h>
  32 .sp
  33 .BI "struct if_nameindex *if_nameindex(void);
  34 .BI "void if_freenameindex(struct if_nameindex *" "ptr" );
  35 .fi
  36 .SH DESCRIPTION
  37 The
  38 .BR if_nameindex ()
  39 function returns an array of
  40 .I if_nameindex
  41 structures, each containing information
  42 about one of the network interfaces on the local system.
  43 The
  44 .I if_nameindex
  45 structure contains at least the following entries:
  46 .sp
  47 .in +4n
  48 .nf
  49     unsigned int if_index; /* Index of interface (1, 2, ...) */
  50     char        *if_name;  /* Null-terminated name ("eth0", etc.) */
  51 .fi
  52 .in
  53 .PP
  54 The
  55 .I if_index
  56 field contains the interface index.
  57 The
  58 .I ifa_name
  59 field points to the null-terminated interface name.
  60 The end of the array is indicated by entry with
  61 .I if_index
  62 set to zero and
  63 .I ifa_name
  64 set to NULL.
  65 .PP
  66 The data structure returned by
  67 .BR if_nameindex ()
  68 is dynamically allocated and should be freed using
  69 .BR if_freenameindex ()
  70 when no longer needed.
  71 .SH RETURN VALUE
  72 On success,
  73 .BR if_nameindex ()
  74 returns pointer to the array;
  75 on error, NULL is returned, and
  76 .I errno
  77 is set appropriately.
  78 .SH ERRORS
  79 .BR if_nameindex ()
  80 may fail and set
  81 .I errno
  82 if:
  83 .TP
  84 .B ENOBUFS
  85 Insufficient resources available.
  86 .PP
  87 .BR if_nameindex ()
  88 may also fail for any of the errors specified for
  89 .BR socket (2),
  90 .BR bind (2),
  91 .BR ioctl (2),
  92 .BR getsockname (2),
  93 .BR recvmsg (2),
  94 .BR sendto (2),
  95 or
  96 .BR malloc (3).
  97 .SH VERSIONS
  98 The
  99 .BR if_nameindex ()
 100 function first appeared in glibc 2.1, but before glibc 2.3.4,
 101 the implementation supported only interfaces with IPv4 addresses.
 102 Support of interfaces that don't have IPv4 addresses is available only
 103 on kernels that support netlink.
 104 .SH CONFORMING TO
 105 RFC\ 3493, POSIX.1-2001.
 106
 107 This function first appeared in BSDi.
 108 .SH EXAMPLE
 109 The program below demonstrates the use of the functions described
 110 on this page.
 111 An example of the output this program might produce is the following:
 112
 113 .in +4n
 114 .nf
 115 $ \fB./a.out\fI
 116 1: lo
 117 2: wlan0
 118 3: em1
 119 .fi
 120 .in
 121 .SS Program source
 122 .nf
 123 #include <net/if.h>
 124 #include <stdio.h>
 125 #include <stdlib.h>
 126 #include <unistd.h>
 127
 128 int
 129 main(int argc, char *argv[])
 130 {
 131     struct if_nameindex *if_ni, *i;
 132
 133     if_ni = if_nameindex();
 134     if (if_ni == NULL) {
 135         perror("if_nameindex");
 136         exit(EXIT_FAILURE);
 137     }
 138
 139     for (i = if_ni; ! (i\->if_index == 0 && i\->if_name == NULL); i++)
 140         printf("%u: %s\\n", i\->if_index, i\->if_name);
 141
 142     if_freenameindex(if_ni);
 143
 144     exit(EXIT_SUCCESS);
 145 }
 146 .fi
 147 .SH SEE ALSO
 148 .BR getsockopt (2),
 149 .BR setsockopt (2),
 150 .BR getifaddrs (3),
 151 .BR if_indextoname (3),
 152 .BR if_nametoindex (3),
 153 .BR ifconfig (8)
 154 .SH COLOPHON
 155 This page is part of release 3.79 of the Linux
 156 .I man-pages
 157 project.
 158 A description of the project,
 159 information about reporting bugs,
 160 and the latest version of this page,
 161 can be found at
 162 \%http://www.kernel.org/doc/man\-pages/.