Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › GetIpNetTable2

GetIpNetTable2

関数
指定アドレスファミリの近隣(ARP/NDP)テーブルを取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

WIN32_ERROR GetIpNetTable2(
    ADDRESS_FAMILY Family,
    MIB_IPNET_TABLE2** Table
);

パラメーター

名前方向説明
FamilyADDRESS_FAMILYin

取得するアドレスファミリ。

アドレスファミリに指定できる値は Winsock2.h ヘッダーファイルに記載されています。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である(例: AF_INETPF_INET)ため、どちらの定数を使用してもかまいません。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更されており、このメンバーに指定できる値は Ws2def.h ヘッダーファイルで定義されています。Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用してはなりません。

現在サポートされている値は AF_INETAF_INET6AF_UNSPEC です。

意味
AF_UNSPEC
0
アドレスファミリは未指定です。このパラメーターを指定すると、本関数は IPv4 と IPv6 の両方のエントリを含む近隣 IP アドレステーブルを返します。
AF_INET
2
インターネットプロトコルバージョン 4 (IPv4) アドレスファミリです。このパラメーターを指定すると、本関数は IPv4 エントリのみを含む近隣 IP アドレステーブルを返します。
AF_INET6
23
インターネットプロトコルバージョン 6 (IPv6) アドレスファミリです。このパラメーターを指定すると、本関数は IPv6 エントリのみを含む近隣 IP アドレステーブルを返します。
TableMIB_IPNET_TABLE2**outローカルコンピューター上の近隣 IP アドレスエントリのテーブルを格納する MIB_IPNET_TABLE2 構造体へのポインターへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

GetIpNetTable2 関数は、ローカルコンピューター上の IP 近隣テーブルを取得します。

戻り値

関数が成功した場合、戻り値は NO_ERROR または ERROR_NOT_FOUND です。

関数が失敗した場合、またはデータを返さなかった場合、戻り値は次のいずれかのエラーコードになります。

戻り値 説明
ERROR_INVALID_PARAMETER
関数に無効なパラメーターが渡されました。このエラーは、Table パラメーターに NULL ポインターが渡された場合、または Family パラメーターが AF_INETAF_INET6AF_UNSPEC のいずれにも指定されていない場合に返されます。
ERROR_NOT_ENOUGH_MEMORY
操作を完了するのに十分なメモリリソースがありません。
ERROR_NOT_FOUND
Family パラメーターで指定された近隣 IP アドレスエントリが見つかりませんでした。

この戻り値は、GetIpNetTable2 関数の呼び出しは成功したものの、返すデータが存在しなかったことを示します。これは、Family パラメーターに AF_INET が指定され、かつ返すべき ARP エントリが存在しない場合に発生することがあります。

ERROR_NOT_SUPPORTED
要求はサポートされていません。

このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、Family パラメーターに AF_INET が指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず、Family パラメーターに AF_INET6 が指定された場合にも返されます。さらに、本関数がサポートされていないバージョンの Windows でも返されます。

その他
返されたエラーのメッセージ文字列を取得するには、FormatMessage を使用してください。

解説(Remarks)

GetIpNetTable2 関数は Windows Vista 以降で定義されています。

GetIpNetTable2 関数は、ローカルシステム上の近隣 IP アドレスを列挙し、その情報を MIB_IPNET_TABLE2 構造体で返します。

近隣 IP アドレスエントリは、Table パラメーターが指すバッファー内の MIB_IPNET_TABLE2 構造体で返されます。MIB_IPNET_TABLE2 構造体には、近隣 IP アドレスエントリの数と、各近隣 IP アドレスエントリに対応する MIB_IPNET_ROW2 構造体の配列が格納されます。これらの返された構造体が不要になったら、FreeMibTable を呼び出してメモリを解放してください。

Family パラメーターは、AF_INETAF_INET6AF_UNSPEC のいずれかに初期化する必要があります。

Table パラメーターが指す、返された MIB_IPNET_TABLE2 構造体には、NumEntries メンバーと、MIB_IPNET_TABLE2 構造体の Table メンバーにおける最初の MIB_IPNET_ROW2 配列エントリとの間に、アライメントのためのパディングが含まれる場合があることに注意してください。また、MIB_IPNET_ROW2 配列エントリの間にもアライメントのためのパディングが存在する場合があります。MIB_IPNET_ROW2 配列エントリにアクセスする際は、常にパディングが存在する可能性を考慮してください。

次の例は、IP 近隣テーブルを取得し、テーブル内の IP 近隣行エントリの値を出力します。

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <windows.h>
#include <winsock2.h>
#include <ws2ipdef.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>

#pragma comment(lib, "iphlpapi.lib")
#pragma comment(lib, "ws2_32.lib")

int main()
{

    // Declare and initialize variables

    int i;
    unsigned int j;
    unsigned long status = 0;

    PMIB_IPNET_TABLE2 pipTable = NULL;
//    MIB_IPNET_ROW2 ipRow;

    status = GetIpNetTable2(AF_INET, &pipTable);
    if (status != NO_ERROR) {
        printf("GetIpNetTable for IPv4 table returned error: %ld\n", status);
        exit(1);
    }
    // Print some variables from the table
    printf("Number of IPv4 table entries: %d\n\n", pipTable->NumEntries);

    for (i = 0; (unsigned) i < pipTable->NumEntries; i++) {
//        printf("Table entry: %d\n", i);
        printf("IPv4 Address[%d]:\t %s\n", (int) i,
               inet_ntoa(pipTable->Table[i].Address.Ipv4.sin_addr));
        printf("Interface index[%d]:\t\t %lu\n", (int) i,
               pipTable->Table[i].InterfaceIndex);

        printf("Interface LUID NetLuidIndex[%d]:\t %lu\n",
               (int) i, pipTable->Table[i].InterfaceLuid.Info.NetLuidIndex);
        printf("Interface LUID IfType[%d]: ", (int) i);
        switch (pipTable->Table[i].InterfaceLuid.Info.IfType) {
        case IF_TYPE_OTHER:
            printf("Other\n");
            break;
        case IF_TYPE_ETHERNET_CSMACD:
            printf("Ethernet\n");
            break;
        case IF_TYPE_ISO88025_TOKENRING:
            printf("Token ring\n");
            break;
        case IF_TYPE_PPP:
            printf("PPP\n");
            break;
        case IF_TYPE_SOFTWARE_LOOPBACK:
            printf("Software loopback\n");
            break;
        case IF_TYPE_ATM:
            printf("ATM\n");
            break;
        case IF_TYPE_IEEE80211:
            printf("802.11 wireless\n");
            break;
        case IF_TYPE_TUNNEL:
            printf("Tunnel encapsulation\n");
            break;
        case IF_TYPE_IEEE1394:
            printf("IEEE 1394 (Firewire)\n");
            break;
        default:
            printf("Unknown: %d\n",
                   pipTable->Table[i].InterfaceLuid.Info.IfType);
            break;
        }

        printf("Physical Address[%d]:\t ", (int) i);
        if (pipTable->Table[i].PhysicalAddressLength == 0)
            printf("\n");
//        for (j = 0; (unsigned) j < pipTable->Table[i].PhysicalAddressLength; j++)
//         printf ("%c" 
        for (j = 0; j < pipTable->Table[i].PhysicalAddressLength; j++) {
            if (j == (pipTable->Table[i].PhysicalAddressLength - 1))
                printf("%.2X\n", (int) pipTable->Table[i].PhysicalAddress[j]);
            else
                printf("%.2X-", (int) pipTable->Table[i].PhysicalAddress[j]);
        }

        printf("Physical Address Length[%d]:\t %lu\n", (int) i,
               pipTable->Table[i].PhysicalAddressLength);

        printf("Neighbor State[%d]:\t ", (int) i);
        switch (pipTable->Table[i].State) {
        case NlnsUnreachable:
            printf("NlnsUnreachable\n");
            break;
        case NlnsIncomplete:
            printf("NlnsIncomplete\n");
            break;
        case NlnsProbe:
            printf("NlnsProbe\n");
            break;
        case NlnsDelay:
            printf("NlnsDelay\n");
            break;
        case NlnsStale:
            printf("NlnsStale\n");
            break;
        case NlnsReachable:
            printf("NlnsReachable\n");
            break;
        case NlnsPermanent:
            printf("NlnsPermanent\n");
            break;
        default:
            printf("Unknown: %d\n", pipTable->Table[i].State);
            break;
        }

        printf("Flags[%d]:\t\t %u\n", (int) i,
               (unsigned char) pipTable->Table[i].Flags);

        printf("ReachabilityTime[%d]:\t %lu\n\n", (int) i,
               pipTable->Table[i].ReachabilityTime);

    }
    FreeMibTable(pipTable);
    pipTable = NULL;

    exit(0);
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

WIN32_ERROR GetIpNetTable2(
    ADDRESS_FAMILY Family,
    MIB_IPNET_TABLE2** Table
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpNetTable2(
    ushort Family,   // ADDRESS_FAMILY
    IntPtr Table   // MIB_IPNET_TABLE2** out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpNetTable2(
    Family As UShort,   ' ADDRESS_FAMILY
    Table As IntPtr   ' MIB_IPNET_TABLE2** out
) As UInteger
End Function
' Family : ADDRESS_FAMILY
' Table : MIB_IPNET_TABLE2** out
Declare PtrSafe Function GetIpNetTable2 Lib "iphlpapi" ( _
    ByVal Family As Integer, _
    ByVal Table As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIpNetTable2 = ctypes.windll.iphlpapi.GetIpNetTable2
GetIpNetTable2.restype = wintypes.DWORD
GetIpNetTable2.argtypes = [
    ctypes.c_ushort,  # Family : ADDRESS_FAMILY
    ctypes.c_void_p,  # Table : MIB_IPNET_TABLE2** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpNetTable2 = Fiddle::Function.new(
  lib['GetIpNetTable2'],
  [
    -Fiddle::TYPE_SHORT,  # Family : ADDRESS_FAMILY
    Fiddle::TYPE_VOIDP,  # Table : MIB_IPNET_TABLE2** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetIpNetTable2(
        Family: u16,  // ADDRESS_FAMILY
        Table: *mut *mut MIB_IPNET_TABLE2  // MIB_IPNET_TABLE2** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIpNetTable2(ushort Family, IntPtr Table);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIpNetTable2' -Namespace Win32 -PassThru
# $api::GetIpNetTable2(Family, Table)
#uselib "IPHLPAPI.dll"
#func global GetIpNetTable2 "GetIpNetTable2" sptr, sptr
; GetIpNetTable2 Family, varptr(Table)   ; 戻り値は stat
; Family : ADDRESS_FAMILY -> "sptr"
; Table : MIB_IPNET_TABLE2** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global GetIpNetTable2 "GetIpNetTable2" int, var
; res = GetIpNetTable2(Family, Table)
; Family : ADDRESS_FAMILY -> "int"
; Table : MIB_IPNET_TABLE2** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR GetIpNetTable2(ADDRESS_FAMILY Family, MIB_IPNET_TABLE2** Table)
#uselib "IPHLPAPI.dll"
#cfunc global GetIpNetTable2 "GetIpNetTable2" int, var
; res = GetIpNetTable2(Family, Table)
; Family : ADDRESS_FAMILY -> "int"
; Table : MIB_IPNET_TABLE2** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpNetTable2 = iphlpapi.NewProc("GetIpNetTable2")
)

// Family (ADDRESS_FAMILY), Table (MIB_IPNET_TABLE2** out)
r1, _, err := procGetIpNetTable2.Call(
	uintptr(Family),
	uintptr(Table),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function GetIpNetTable2(
  Family: Word;   // ADDRESS_FAMILY
  Table: Pointer   // MIB_IPNET_TABLE2** out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpNetTable2';
result := DllCall("IPHLPAPI\GetIpNetTable2"
    , "UShort", Family   ; ADDRESS_FAMILY
    , "Ptr", Table   ; MIB_IPNET_TABLE2** out
    , "UInt")   ; return: WIN32_ERROR
●GetIpNetTable2(Family, Table) = DLL("IPHLPAPI.dll", "dword GetIpNetTable2(int, void*)")
# 呼び出し: GetIpNetTable2(Family, Table)
# Family : ADDRESS_FAMILY -> "int"
# Table : MIB_IPNET_TABLE2** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn GetIpNetTable2(
    Family: u16, // ADDRESS_FAMILY
    Table: [*c][*c]MIB_IPNET_TABLE2 // MIB_IPNET_TABLE2** out
) callconv(std.os.windows.WINAPI) u32;
proc GetIpNetTable2(
    Family: uint16,  # ADDRESS_FAMILY
    Table: ptr MIB_IPNET_TABLE2  # MIB_IPNET_TABLE2** out
): uint32 {.importc: "GetIpNetTable2", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpNetTable2(
    ushort Family,   // ADDRESS_FAMILY
    MIB_IPNET_TABLE2** Table   // MIB_IPNET_TABLE2** out
);
ccall((:GetIpNetTable2, "IPHLPAPI.dll"), stdcall, UInt32,
      (UInt16, Ptr{MIB_IPNET_TABLE2}),
      Family, Table)
# Family : ADDRESS_FAMILY -> UInt16
# Table : MIB_IPNET_TABLE2** out -> Ptr{MIB_IPNET_TABLE2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpNetTable2(
    uint16_t Family,
    void* Table);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpNetTable2(Family, Table)
-- Family : ADDRESS_FAMILY
-- Table : MIB_IPNET_TABLE2** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpNetTable2 = lib.func('__stdcall', 'GetIpNetTable2', 'uint32_t', ['uint16_t', 'void *']);
// GetIpNetTable2(Family, Table)
// Family : ADDRESS_FAMILY -> 'uint16_t'
// Table : MIB_IPNET_TABLE2** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIpNetTable2: { parameters: ["u16", "pointer"], result: "u32" },
});
// lib.symbols.GetIpNetTable2(Family, Table)
// Family : ADDRESS_FAMILY -> "u16"
// Table : MIB_IPNET_TABLE2** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpNetTable2(
    uint16_t Family,
    void* Table);
C, "IPHLPAPI.dll");
// $ffi->GetIpNetTable2(Family, Table);
// Family : ADDRESS_FAMILY
// Table : MIB_IPNET_TABLE2** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Iphlpapi extends StdCallLibrary {
    Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
    int GetIpNetTable2(
        short Family,   // ADDRESS_FAMILY
        Pointer Table   // MIB_IPNET_TABLE2** out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIpNetTable2 = GetIpNetTable2(
    Family : UInt16,   # ADDRESS_FAMILY
    Table : MIB_IPNET_TABLE2**   # MIB_IPNET_TABLE2** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetIpNetTable2Native = Uint32 Function(Uint16, Pointer<Void>);
typedef GetIpNetTable2Dart = int Function(int, Pointer<Void>);
final GetIpNetTable2 = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIpNetTable2Native, GetIpNetTable2Dart>('GetIpNetTable2');
// Family : ADDRESS_FAMILY -> Uint16
// Table : MIB_IPNET_TABLE2** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIpNetTable2(
  Family: Word;   // ADDRESS_FAMILY
  Table: Pointer   // MIB_IPNET_TABLE2** out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpNetTable2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIpNetTable2"
  c_GetIpNetTable2 :: Word16 -> Ptr () -> IO Word32
-- Family : ADDRESS_FAMILY -> Word16
-- Table : MIB_IPNET_TABLE2** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getipnettable2 =
  foreign "GetIpNetTable2"
    (uint16_t @-> (ptr void) @-> returning uint32_t)
(* Family : ADDRESS_FAMILY -> uint16_t *)
(* Table : MIB_IPNET_TABLE2** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetIpNetTable2" get-ip-net-table2 :convention :stdcall) :uint32
  (family :uint16)   ; ADDRESS_FAMILY
  (table :pointer))   ; MIB_IPNET_TABLE2** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIpNetTable2 = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIpNetTable2(WORD Family, LPVOID Table)');
# my $ret = $GetIpNetTable2->Call($Family, $Table);
# Family : ADDRESS_FAMILY -> WORD
# Table : MIB_IPNET_TABLE2** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型