ホーム › NetworkManagement.IpHelper › GetIpNetTable

GetIpNetTable

関数

IPv4アドレスと物理アドレスの対応を保持するARPテーブルを取得する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetIpNetTable(
    MIB_IPNETTABLE* IpNetTable,   // optional
    DWORD* SizePointer,
    BOOL Order
);

パラメーター

名前	型	方向	説明
IpNetTable	MIB_IPNETTABLE*	outoptional	IPv4 アドレスと物理アドレスの対応テーブルを MIB_IPNETTABLE 構造体として受け取るバッファーへのポインター。
SizePointer	DWORD*	inout	入力時には、pIpNetTable パラメーターが指すバッファーのサイズをバイト単位で指定します。出力時には、バッファーが返される対応テーブルを保持するのに十分な大きさでない場合、この関数はこのパラメーターに必要なバッファーサイズ(バイト単位)を設定します。
Order	BOOL	in	返される対応テーブルを IP アドレスの昇順でソートするかどうかを指定する Boolean 値。このパラメーターが TRUE の場合、テーブルはソートされます。

名前

型

方向

説明

IpNetTable

MIB_IPNETTABLE*

outoptional

IPv4 アドレスと物理アドレスの対応テーブルを MIB_IPNETTABLE 構造体として受け取るバッファーへのポインター。

SizePointer

DWORD*

inout

入力時には、pIpNetTable パラメーターが指すバッファーのサイズをバイト単位で指定します。

出力時には、バッファーが返される対応テーブルを保持するのに十分な大きさでない場合、この関数はこのパラメーターに必要なバッファーサイズ(バイト単位)を設定します。

Order

BOOL

返される対応テーブルを IP アドレスの昇順でソートするかどうかを指定する Boolean 値。このパラメーターが TRUE の場合、テーブルはソートされます。

戻り値の型: DWORD

公式ドキュメント

GetIpNetTable 関数は、IPv4 アドレスと物理アドレスの対応テーブルを取得します。

戻り値

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

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

Return code	Description
ERROR_INSUFFICIENT_BUFFER	pIpNetTable パラメーターが指すバッファーが十分な大きさではありません。必要なサイズは、pdwSize パラメーターが指す DWORD 変数に返されます。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、pdwSize パラメーターが NULL の場合、または GetIpNetTable が pdwSize パラメーターの指すメモリに書き込めない場合に返されます。
ERROR_NO_DATA	返すデータがありません。IPv4 アドレスと物理アドレスの対応テーブルが空です。この戻り値は、 GetIpNetTable 関数の呼び出しは成功したものの、返すデータが存在しなかったことを示します。
ERROR_NOT_SUPPORTED	ローカルコンピューターで IPv4 トランスポートが構成されていません。
Other	返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

GetIpNetTable 関数は、ローカルシステム上の IPv4 アドレスと物理アドレスの対応テーブルから IPv4 用の Address Resolution Protocol (ARP) エントリを列挙し、その情報を MIB_IPNETTABLE 構造体で返します。

IPv4 アドレスエントリは、pIpNetTable パラメーターが指すバッファー内の MIB_IPNETTABLE 構造体に返されます。MIB_IPNETTABLE 構造体には、ARP エントリの数と、各 IPv4 アドレスエントリに対応する MIB_IPNETROW 構造体の配列が含まれます。

pIpNetTable パラメーターが指す返された MIB_IPNETTABLE 構造体には、dwNumEntries メンバーと MIB_IPNETTABLE 構造体の table メンバーにある最初の MIB_IPNETROW 配列エントリとの間に、アライメント用のパディングが含まれる場合があることに注意してください。アライメント用のパディングは、MIB_IPNETROW 配列エントリの間にも存在する場合があります。MIB_IPNETROW 配列エントリにアクセスする際は、パディングが存在する可能性があることを前提とする必要があります。

Windows Vista 以降では、GetIpNetTable2 関数を使用して、IPv6 と IPv4 の両方の近隣 IP アドレスを取得できます。

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

各言語での呼び出し定義

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

DWORD GetIpNetTable(
    MIB_IPNETTABLE* IpNetTable,   // optional
    DWORD* SizePointer,
    BOOL Order
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpNetTable(
    IntPtr IpNetTable,   // MIB_IPNETTABLE* optional, out
    ref uint SizePointer,   // DWORD* in/out
    bool Order   // BOOL
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpNetTable(
    IpNetTable As IntPtr,   ' MIB_IPNETTABLE* optional, out
    ByRef SizePointer As UInteger,   ' DWORD* in/out
    Order As Boolean   ' BOOL
) As UInteger
End Function

' IpNetTable : MIB_IPNETTABLE* optional, out
' SizePointer : DWORD* in/out
' Order : BOOL
Declare PtrSafe Function GetIpNetTable Lib "iphlpapi" ( _
    ByVal IpNetTable As LongPtr, _
    ByRef SizePointer As Long, _
    ByVal Order As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetIpNetTable = ctypes.windll.iphlpapi.GetIpNetTable
GetIpNetTable.restype = wintypes.DWORD
GetIpNetTable.argtypes = [
    ctypes.c_void_p,  # IpNetTable : MIB_IPNETTABLE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # SizePointer : DWORD* in/out
    wintypes.BOOL,  # Order : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpNetTable = Fiddle::Function.new(
  lib['GetIpNetTable'],
  [
    Fiddle::TYPE_VOIDP,  # IpNetTable : MIB_IPNETTABLE* optional, out
    Fiddle::TYPE_VOIDP,  # SizePointer : DWORD* in/out
    Fiddle::TYPE_INT,  # Order : BOOL
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetIpNetTable(
        IpNetTable: *mut MIB_IPNETTABLE,  // MIB_IPNETTABLE* optional, out
        SizePointer: *mut u32,  // DWORD* in/out
        Order: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIpNetTable(IntPtr IpNetTable, ref uint SizePointer, bool Order);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIpNetTable' -Namespace Win32 -PassThru
# $api::GetIpNetTable(IpNetTable, SizePointer, Order)

#uselib "IPHLPAPI.dll"
#func global GetIpNetTable "GetIpNetTable" sptr, sptr, sptr
; GetIpNetTable varptr(IpNetTable), varptr(SizePointer), Order   ; 戻り値は stat
; IpNetTable : MIB_IPNETTABLE* optional, out -> "sptr"
; SizePointer : DWORD* in/out -> "sptr"
; Order : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global GetIpNetTable "GetIpNetTable" var, var, int
; res = GetIpNetTable(IpNetTable, SizePointer, Order)
; IpNetTable : MIB_IPNETTABLE* optional, out -> "var"
; SizePointer : DWORD* in/out -> "var"
; Order : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global GetIpNetTable "GetIpNetTable" sptr, sptr, int
; res = GetIpNetTable(varptr(IpNetTable), varptr(SizePointer), Order)
; IpNetTable : MIB_IPNETTABLE* optional, out -> "sptr"
; SizePointer : DWORD* in/out -> "sptr"
; Order : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。