1 .\" $KAME: if_indextoname.3,v 1.10 2000/11/24 08:13:51 itojun Exp $
2 .\" BSDI Id: if_indextoname.3,v 2.2 2000/04/17 22:38:05 dab Exp
4 .\" Copyright (c) 1997, 2000
5 .\" Berkeley Software Design, Inc. All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
13 .\" THIS SOFTWARE IS PROVIDED BY Berkeley Software Design, Inc. ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL Berkeley Software Design, Inc. BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd provide mappings between interface names and indexes
39 .Fn if_nametoindex "const char *ifname"
41 .Fn if_indextoname "unsigned int ifindex" "char *ifname"
42 .Ft "struct if_nameindex *"
43 .Fn if_nameindex "void"
45 .Fn if_freenameindex "struct if_nameindex *ptr"
49 function maps the interface name specified in
51 to its corresponding index.
52 If the specified interface does not exist, it returns 0.
56 function maps the interface index specified in
58 to it corresponding name, which is copied into the
61 which must be of at least
64 This pointer is also the return value of the function.
65 If there is no interface corresponding to the specified
72 function returns an array of
74 structures, one structure per interface, as
75 defined in the include file
79 structure contains at least the following entries:
81 unsigned int if_index; /* 1, 2, ... */
82 char *if_name; /* null terminated name: "le0", ... */
85 The end of the array of structures is indicated by a structure with an
93 pointer is returned upon an error.
97 function frees the dynamic memory that was
101 Upon successful completion,
103 returns the index number of the interface.
104 If the interface is not found, a value of 0 is returned and
108 A value of 0 is also returned if an error
109 occurs while retrieving the list of interfaces via
112 Upon successful completion,
116 If the interface is not found, a
118 pointer is returned and
124 pointer is also returned if an error
125 occurs while retrieving the list of interfaces via
133 occurs while retrieving the list of interfaces via
135 or if sufficient memory cannot be allocated.
149 The implementation first appeared in BSDi