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

GetIpAddrTable

関数
各インターフェイスに割り当てられたIPv4アドレスの一覧表を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetIpAddrTable(
    MIB_IPADDRTABLE* pIpAddrTable,   // optional
    DWORD* pdwSize,
    BOOL bOrder
);

パラメーター

名前方向説明
pIpAddrTableMIB_IPADDRTABLE*outoptionalインターフェイスと IPv4 アドレスの対応付けテーブルを MIB_IPADDRTABLE 構造体として受け取るバッファーへのポインター。
pdwSizeDWORD*inout

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

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

bOrderBOOLinこのパラメーターが TRUE の場合、 返される対応付けテーブルは IPv4 アドレスの昇順にソートされます。 ソートはネットワークバイトオーダーで行われます。 たとえば、10.0.0.255 は 10.0.1.0 のすぐ前になります。

戻り値の型: DWORD

公式ドキュメント

GetIpAddrTable 関数は、インターフェイスと IPv4 アドレスの対応付けテーブルを取得します。

戻り値

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

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

戻り値 説明
ERROR_INSUFFICIENT_BUFFER
pIpAddrTable パラメーターが指すバッファーが十分な大きさではありません。必要なサイズは、pdwSize パラメーターが指す DWORD 変数に返されます。
ERROR_INVALID_PARAMETER
pdwSize パラメーターが NULL であるか、 GetIpAddrTablepdwSize パラメーターの指すメモリに書き込めません。
ERROR_NOT_SUPPORTED
この関数は、ローカルシステムで使用されているオペレーティングシステムではサポートされていません。
その他
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

GetIpAddrTable 関数は、ローカルコンピューター上のインターフェイスと IPv4 アドレスの対応付けテーブルを取得し、この情報を MIB_IPADDRTABLE 構造体で返します。

GetIpAddrTable 関数が返す IPv4 アドレスは、ローカルコンピューター上のネットワークインターフェイスの状態の影響を受けます。ネットワークインターフェイスカード(NIC)を手動でリセットしたり、特定の PnP イベントが発生したりすると、IP アドレスが削除または変更されることがあります。

Windows Server 2003 および Windows XP では、GetIpAddrTable 関数が返す IPv4 アドレスは、ローカルコンピューター上の TCP/IP スタックのメディアセンス機能が DisableMediaSense 関数の呼び出しによって無効化されている場合にも影響を受けます。メディアセンスが無効化されている場合、GetIpAddrTable 関数は切断されたインターフェイスに関連付けられた IPv4 アドレスを返すことがあります。切断されたインターフェイスのこれらの IPv4 アドレスは使用できません。

Windows Server 2008 および Windows Vista では、GetIpAddrTable 関数が返す IPv4 アドレスは、ローカルコンピューター上の TCP/IP スタックのメディアセンス機能の影響を受けません。GetIpAddrTable 関数は有効な IPv4 アドレスのみを返します。

Windows XP で利用可能な GetAdaptersAddresses 関数を使用すると、IPv6 アドレスと IPv4 アドレスの両方、およびインターフェイス情報を取得できます。

GetIpAddrTable 関数が返す MIB_IPADDRTABLE 構造体には、dwNumEntries メンバーと table メンバー内の最初の MIB_IPADDRROW 配列エントリとの間に、アライメントのためのパディングが含まれることがあります。table メンバー内の MIB_IPADDRROW 配列エントリ間にも、アライメントのためのパディングが存在することがあります。MIB_IPADDRROW 配列エントリにアクセスする際は、常にパディングが存在する可能性があると想定する必要があります。

Windows Vista 以降向けにリリースされた Microsoft Windows Software Development Kit (SDK) では、ヘッダーファイルの構成が変更され、MIB_IPADDRROWIprtrmib.h ヘッダーファイルではなく Ipmib.h ヘッダーファイルで定義されています。なお、Ipmib.h ヘッダーファイルは Iprtrmib.h に自動的にインクルードされ、Iprtrmib.hIphlpapi.h ヘッダーファイルに自動的にインクルードされます。Ipmib.h および Iprtrmib.h ヘッダーファイルを直接使用してはなりません。

次の例は IP アドレステーブルを取得し、テーブル内の IP アドレスエントリのいくつかのメンバーを出力します。

#include <winsock2.h>
#include <ws2tcpip.h>
#include <iphlpapi.h>
#include <stdio.h>

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

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

/* Note: could also use malloc() and free() */

int __cdecl main()
{

    int i;
    
    /* Variables used by GetIpAddrTable */
    PMIB_IPADDRTABLE pIPAddrTable;
    DWORD dwSize = 0;
    DWORD dwRetVal = 0;
    IN_ADDR IPAddr;

    /* Variables used to return error message */
    LPVOID lpMsgBuf;

    // Before calling AddIPAddress we use GetIpAddrTable to get
    // an adapter to which we can add the IP.
    pIPAddrTable = (MIB_IPADDRTABLE *) MALLOC(sizeof (MIB_IPADDRTABLE));

    if (pIPAddrTable) {
        // Make an initial call to GetIpAddrTable to get the
        // necessary size into the dwSize variable
        if (GetIpAddrTable(pIPAddrTable, &dwSize, 0) ==
            ERROR_INSUFFICIENT_BUFFER) {
            FREE(pIPAddrTable);
            pIPAddrTable = (MIB_IPADDRTABLE *) MALLOC(dwSize);

        }
        if (pIPAddrTable == NULL) {
            printf("Memory allocation failed for GetIpAddrTable\n");
            exit(1);
        }
    }
    // Make a second call to GetIpAddrTable to get the
    // actual data we want
    if ( (dwRetVal = GetIpAddrTable( pIPAddrTable, &dwSize, 0 )) != NO_ERROR ) { 
        printf("GetIpAddrTable failed with error %d\n", dwRetVal);
        if (FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, dwRetVal, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),       // Default language
                          (LPTSTR) & lpMsgBuf, 0, NULL)) {
            printf("\tError: %s", lpMsgBuf);
            LocalFree(lpMsgBuf);
        }
        exit(1);
    }

    printf("\tNum Entries: %ld\n", pIPAddrTable->dwNumEntries);
    for (i=0; i < (int) pIPAddrTable->dwNumEntries; i++) {
        printf("\n\tInterface Index[%d]:\t%ld\n", i, pIPAddrTable->table[i].dwIndex);
        IPAddr.S_un.S_addr = (u_long) pIPAddrTable->table[i].dwAddr;
        printf("\tIP Address[%d]:     \t%s\n", i, inet_ntoa(IPAddr) );
        IPAddr.S_un.S_addr = (u_long) pIPAddrTable->table[i].dwMask;
        printf("\tSubnet Mask[%d]:    \t%s\n", i, inet_ntoa(IPAddr) );
        IPAddr.S_un.S_addr = (u_long) pIPAddrTable->table[i].dwBCastAddr;
        printf("\tBroadCast[%d]:      \t%s (%ld%)\n", i, inet_ntoa(IPAddr), pIPAddrTable->table[i].dwBCastAddr);
        printf("\tReassembly size[%d]:\t%ld\n", i, pIPAddrTable->table[i].dwReasmSize);
        printf("\tType and State[%d]:", i);
        if (pIPAddrTable->table[i].wType & MIB_IPADDR_PRIMARY)
            printf("\tPrimary IP Address");
        if (pIPAddrTable->table[i].wType & MIB_IPADDR_DYNAMIC)
            printf("\tDynamic IP Address");
        if (pIPAddrTable->table[i].wType & MIB_IPADDR_DISCONNECTED)
            printf("\tAddress is on disconnected interface");
        if (pIPAddrTable->table[i].wType & MIB_IPADDR_DELETED)
            printf("\tAddress is being deleted");
        if (pIPAddrTable->table[i].wType & MIB_IPADDR_TRANSIENT)
            printf("\tTransient address");
        printf("\n");
    }

    if (pIPAddrTable) {
        FREE(pIPAddrTable);
        pIPAddrTable = 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>

DWORD GetIpAddrTable(
    MIB_IPADDRTABLE* pIpAddrTable,   // optional
    DWORD* pdwSize,
    BOOL bOrder
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpAddrTable(
    IntPtr pIpAddrTable,   // MIB_IPADDRTABLE* optional, out
    ref uint pdwSize,   // DWORD* in/out
    bool bOrder   // BOOL
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpAddrTable(
    pIpAddrTable As IntPtr,   ' MIB_IPADDRTABLE* optional, out
    ByRef pdwSize As UInteger,   ' DWORD* in/out
    bOrder As Boolean   ' BOOL
) As UInteger
End Function
' pIpAddrTable : MIB_IPADDRTABLE* optional, out
' pdwSize : DWORD* in/out
' bOrder : BOOL
Declare PtrSafe Function GetIpAddrTable Lib "iphlpapi" ( _
    ByVal pIpAddrTable As LongPtr, _
    ByRef pdwSize As Long, _
    ByVal bOrder As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIpAddrTable = ctypes.windll.iphlpapi.GetIpAddrTable
GetIpAddrTable.restype = wintypes.DWORD
GetIpAddrTable.argtypes = [
    ctypes.c_void_p,  # pIpAddrTable : MIB_IPADDRTABLE* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pdwSize : DWORD* in/out
    wintypes.BOOL,  # bOrder : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpAddrTable = iphlpapi.NewProc("GetIpAddrTable")
)

// pIpAddrTable (MIB_IPADDRTABLE* optional, out), pdwSize (DWORD* in/out), bOrder (BOOL)
r1, _, err := procGetIpAddrTable.Call(
	uintptr(pIpAddrTable),
	uintptr(pdwSize),
	uintptr(bOrder),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetIpAddrTable(
  pIpAddrTable: Pointer;   // MIB_IPADDRTABLE* optional, out
  pdwSize: Pointer;   // DWORD* in/out
  bOrder: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpAddrTable';
result := DllCall("IPHLPAPI\GetIpAddrTable"
    , "Ptr", pIpAddrTable   ; MIB_IPADDRTABLE* optional, out
    , "Ptr", pdwSize   ; DWORD* in/out
    , "Int", bOrder   ; BOOL
    , "UInt")   ; return: DWORD
●GetIpAddrTable(pIpAddrTable, pdwSize, bOrder) = DLL("IPHLPAPI.dll", "dword GetIpAddrTable(void*, void*, bool)")
# 呼び出し: GetIpAddrTable(pIpAddrTable, pdwSize, bOrder)
# pIpAddrTable : MIB_IPADDRTABLE* optional, out -> "void*"
# pdwSize : DWORD* in/out -> "void*"
# bOrder : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn GetIpAddrTable(
    pIpAddrTable: [*c]MIB_IPADDRTABLE, // MIB_IPADDRTABLE* optional, out
    pdwSize: [*c]u32, // DWORD* in/out
    bOrder: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc GetIpAddrTable(
    pIpAddrTable: ptr MIB_IPADDRTABLE,  # MIB_IPADDRTABLE* optional, out
    pdwSize: ptr uint32,  # DWORD* in/out
    bOrder: int32  # BOOL
): uint32 {.importc: "GetIpAddrTable", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpAddrTable(
    MIB_IPADDRTABLE* pIpAddrTable,   // MIB_IPADDRTABLE* optional, out
    uint* pdwSize,   // DWORD* in/out
    int bOrder   // BOOL
);
ccall((:GetIpAddrTable, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IPADDRTABLE}, Ptr{UInt32}, Int32),
      pIpAddrTable, pdwSize, bOrder)
# pIpAddrTable : MIB_IPADDRTABLE* optional, out -> Ptr{MIB_IPADDRTABLE}
# pdwSize : DWORD* in/out -> Ptr{UInt32}
# bOrder : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpAddrTable(
    void* pIpAddrTable,
    uint32_t* pdwSize,
    int32_t bOrder);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpAddrTable(pIpAddrTable, pdwSize, bOrder)
-- pIpAddrTable : MIB_IPADDRTABLE* optional, out
-- pdwSize : DWORD* in/out
-- bOrder : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpAddrTable = lib.func('__stdcall', 'GetIpAddrTable', 'uint32_t', ['void *', 'uint32_t *', 'int32_t']);
// GetIpAddrTable(pIpAddrTable, pdwSize, bOrder)
// pIpAddrTable : MIB_IPADDRTABLE* optional, out -> 'void *'
// pdwSize : DWORD* in/out -> 'uint32_t *'
// bOrder : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIpAddrTable: { parameters: ["pointer", "pointer", "i32"], result: "u32" },
});
// lib.symbols.GetIpAddrTable(pIpAddrTable, pdwSize, bOrder)
// pIpAddrTable : MIB_IPADDRTABLE* optional, out -> "pointer"
// pdwSize : DWORD* in/out -> "pointer"
// bOrder : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpAddrTable(
    void* pIpAddrTable,
    uint32_t* pdwSize,
    int32_t bOrder);
C, "IPHLPAPI.dll");
// $ffi->GetIpAddrTable(pIpAddrTable, pdwSize, bOrder);
// pIpAddrTable : MIB_IPADDRTABLE* optional, out
// pdwSize : DWORD* in/out
// bOrder : BOOL
// 構造体/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 GetIpAddrTable(
        Pointer pIpAddrTable,   // MIB_IPADDRTABLE* optional, out
        IntByReference pdwSize,   // DWORD* in/out
        boolean bOrder   // BOOL
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIpAddrTable = GetIpAddrTable(
    pIpAddrTable : MIB_IPADDRTABLE*,   # MIB_IPADDRTABLE* optional, out
    pdwSize : UInt32*,   # DWORD* in/out
    bOrder : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetIpAddrTableNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Int32);
typedef GetIpAddrTableDart = int Function(Pointer<Void>, Pointer<Uint32>, int);
final GetIpAddrTable = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIpAddrTableNative, GetIpAddrTableDart>('GetIpAddrTable');
// pIpAddrTable : MIB_IPADDRTABLE* optional, out -> Pointer<Void>
// pdwSize : DWORD* in/out -> Pointer<Uint32>
// bOrder : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIpAddrTable(
  pIpAddrTable: Pointer;   // MIB_IPADDRTABLE* optional, out
  pdwSize: Pointer;   // DWORD* in/out
  bOrder: BOOL   // BOOL
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpAddrTable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIpAddrTable"
  c_GetIpAddrTable :: Ptr () -> Ptr Word32 -> CInt -> IO Word32
-- pIpAddrTable : MIB_IPADDRTABLE* optional, out -> Ptr ()
-- pdwSize : DWORD* in/out -> Ptr Word32
-- bOrder : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getipaddrtable =
  foreign "GetIpAddrTable"
    ((ptr void) @-> (ptr uint32_t) @-> int32_t @-> returning uint32_t)
(* pIpAddrTable : MIB_IPADDRTABLE* optional, out -> (ptr void) *)
(* pdwSize : DWORD* in/out -> (ptr uint32_t) *)
(* bOrder : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetIpAddrTable" get-ip-addr-table :convention :stdcall) :uint32
  (p-ip-addr-table :pointer)   ; MIB_IPADDRTABLE* optional, out
  (pdw-size :pointer)   ; DWORD* in/out
  (b-order :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIpAddrTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIpAddrTable(LPVOID pIpAddrTable, LPVOID pdwSize, BOOL bOrder)');
# my $ret = $GetIpAddrTable->Call($pIpAddrTable, $pdwSize, $bOrder);
# pIpAddrTable : MIB_IPADDRTABLE* optional, out -> LPVOID
# pdwSize : DWORD* in/out -> LPVOID
# bOrder : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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