plucky (3) if_freenameindex.3.gz

名前

       if_nameindex, if_freenameindex - ネットワークインターフェースの名前とインデックスを取得する

書式

       #include <net/if.h>

       struct if_nameindex *if_nameindex(void);
       void if_freenameindex(struct if_nameindex *ptr);

説明

       if_nameindex()  関数は  if_nameindex  構造体の配列を返す。 各構造体にはローカルシステムのネットワークイン
       ターフェースのいずれかの情報が入る。 if_nameindex 構造体には少なくとも以下のフィールドがある。

           unsigned int if_index; /* インターフェースのインデックス (1, 2, ...) */
           char        *if_name;  /*ヌル終端された名前 ("eth0" など) */

       if_index フィールドにはインターフェースのインデックスが入る。 if_name  フィールドはヌル終端されたインター
       フェース名を指す。 配列の最後は、 if_index が 0 で if_name が NULL のエントリーで示される。

       if_nameindex()  が返すデータ構造体は動的に確保される。 必要なくなった際には if_freenameindex() で解放すべ
       きである。

返り値

       成功した場合には if_nameindex() は配列へのポインターを返す。エラー時には NULL が返され、 errno が適切に設
       定される。

エラー

       if_nameindex() が失敗した場合には以下の errno が設定される。

       ENOBUFS
              利用可能なリソースが十分にない。

       if_nameindex() は、 socket(2), bind(2), ioctl(2), getsockname(2), recvmsg(2), sendto(2), malloc(3) に対し
       て規定されているエラーのいずれかで失敗する場合がある。

バージョン

       if_nameindex() 関数は glibc 2.1 で初めて登場したが、 glibc 2.3.4 より前のバージョンの実装では IPv4 アドレ
       スを持つインターフェースのみをサポートしていた。  IPv4 アドレスを持たないインターフェースがサポートされて
       いるのは、 netlink をサポートするカーネルにおいてのみである。

属性

       この節で使用されている用語の説明については、 attributes(7) を参照。

       ┌───────────────────┬───────────────┬─────────┐
       │インターフェース   │ 属性          │ 値      │
       ├───────────────────┼───────────────┼─────────┤
       │if_nameindex(),    │ Thread safety │ MT-Safe │
       │if_freenameindex() │               │         │
       └───────────────────┴───────────────┴─────────┘

準拠

       POSIX.1-2001, POSIX.1-2008, RFC 3493.

       この関数は BSDi 初めて登場した。

例

       以下のプログラムはこのページで説明した関数の使い方を示している。このプログラムが生成する出力は以下のよう
       になる。

           $ ./a.out
           1: lo
           2: wlan0
           3: em1

   プログラムのソース
       #include <net/if.h>
       #include <stdio.h>
       #include <stdlib.h>
       #include <unistd.h>

       int
       main(int argc, char *argv[])
       {
           struct if_nameindex *if_ni, *i;

           if_ni = if_nameindex();
           if (if_ni == NULL) {
               perror("if_nameindex");
               exit(EXIT_FAILURE);
           }

           for (i = if_ni; ! (i->if_index == 0 && i->if_name == NULL); i++)
               printf("%u: %s\n", i->if_index, i->if_name);

           if_freenameindex(if_ni);

           exit(EXIT_SUCCESS);
       }

関連項目

       getsockopt(2), setsockopt(2), getifaddrs(3), if_indextoname(3), if_nametoindex(3), ifconfig(8)

この文書について

       この  man ページは Linux man-pages プロジェクトのリリース 5.10 の一部である。プロジェクトの説明とバグ報告
       に関する情報は https://www.kernel.org/doc/man-pages/ に書かれている。