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

GetInterfaceInfo

関数
システム上のネットワークインターフェイス名と索引の一覧を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetInterfaceInfo(
    IP_INTERFACE_INFO* pIfTable,   // optional
    DWORD* dwOutBufLen
);

パラメーター

名前方向説明
pIfTableIP_INTERFACE_INFO*outoptionalアダプターの一覧を受け取る IP_INTERFACE_INFO 構造体を指定するバッファーへのポインターです。このバッファーは呼び出し元が割り当てる必要があります。
dwOutBufLenDWORD*inoutIP_INTERFACE_INFO 構造体を受け取るために pIfTable パラメーターが指すバッファーのサイズを指定する DWORD 変数へのポインターです。このサイズが IPv4 インターフェイス情報を保持するのに不十分な場合、 GetInterfaceInfo はこの変数に必要なサイズを設定し、エラーコード ERROR_INSUFFICIENT_BUFFER を返します。

戻り値の型: DWORD

公式ドキュメント

GetInterfaceInfo 関数は、ローカルシステム上で IPv4 が有効になっているネットワークインターフェイスアダプターの一覧を取得します。

戻り値

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

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

戻り値 説明
ERROR_INSUFFICIENT_BUFFER
IPv4 アダプター情報を受け取るバッファーが小さすぎます。この値は、dwOutBufLen パラメーターが、pIfTable パラメーターの指すバッファーが IPv4 インターフェイス情報を取得するには小さすぎることを示している場合に返されます。必要なサイズは、dwOutBufLen パラメーターの指す DWORD 変数に返されます。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、dwOutBufLen パラメーターが NULL である場合、または GetInterfaceInfodwOutBufLen パラメーターの指すメモリに書き込めない場合に返されます。
ERROR_NO_DATA
ローカルシステム上に IPv4 が有効なネットワークアダプターがありません。この値は、ローカルシステム上のすべてのネットワークアダプターが無効になっている場合にも返されます。
ERROR_NOT_SUPPORTED
この関数は、ローカルシステムで使用されているオペレーティングシステムではサポートされていません。
その他

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

解説(Remarks)

GetInterfaceInfo 関数は、IPv4 が有効なネットワークアダプターに固有のものです。この関数は、pIfTable パラメーターが指す IP_INTERFACE_INFO 構造体を返します。この構造体には、ローカルシステム上で IPv4 が有効なネットワークアダプターの数と、IPv4 が有効な各ネットワークアダプターの情報を持つ IP_ADAPTER_INDEX_MAP 構造体の配列が含まれます。GetInterfaceInfo が返す IP_INTERFACE_INFO 構造体は、IP_INTERFACE_INFO 構造体の NumAdapters メンバーが IPv4 の有効なネットワークアダプターが存在しないことを示している場合でも、少なくとも 1 つの IP_ADAPTER_INDEX_MAP 構造体を含みます。GetInterfaceInfo が返す IP_INTERFACE_INFO 構造体の NumAdapters メンバーが 0 の場合、IP_INTERFACE_INFO 構造体内で返される単一の IP_ADAPTER_INDEX_MAP 構造体のメンバーの値は未定義です。

IPv4 インターフェイス情報を取得するには小さすぎるバッファーで GetInterfaceInfo 関数が呼び出された場合(dwOutBufLen パラメーターが、pIfTable パラメーターの指すバッファーが小さすぎることを示している場合)、関数は ERROR_INSUFFICIENT_BUFFER を返します。必要なサイズは、dwOutBufLen パラメーターの指す DWORD 変数に返されます。

GetInterfaceInfo 関数の正しい使い方は、この関数を 2 回呼び出すことです。1 回目の呼び出しでは、pIfTable パラメーターに NULL ポインターを渡し、dwOutBufLen パラメーターの指す変数に 0 を渡します。この呼び出しは ERROR_INSUFFICIENT_BUFFER で失敗し、このバッファーに必要なサイズが dwOutBufLen パラメーターの指す DWORD 変数に返されます。その後、dwOutBufLen が指す値を使用して、必要なサイズのバッファーを割り当てることができます。次に、このバッファーへのポインターを pIfTable パラメーターに渡し、バッファーの長さをこのバッファーのサイズに設定して、GetInterfaceInfo 関数を 2 回目に呼び出します。

GetAdaptersInfo 関数と GetInterfaceInfo 関数は、ループバックインターフェイスに関する情報を返しません。ループバックインターフェイスに関する情報は、GetIpAddrTable 関数によって返されます。

Windows Vista 以降では、IP_INTERFACE_INFO 構造体内で返される IP_ADAPTER_INDEX_MAP 構造体の Name メンバーは、ネットワークインターフェイスの GUID を表す Unicode 文字列(文字列は '{' 文字で始まります)になる場合があります。

次の例は、ローカルシステム上で IPv4 が有効なネットワークアダプターの一覧を取得し、最初のネットワークアダプターのさまざまなプロパティを出力します。

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

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

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

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

int main()
{

// Declare and initialize variables
    PIP_INTERFACE_INFO pInfo = NULL;
    ULONG ulOutBufLen = 0;

    DWORD dwRetVal = 0;
    int iReturn = 1;

    int i;

// Make an initial call to GetInterfaceInfo to get
// the necessary size in the ulOutBufLen variable
    dwRetVal = GetInterfaceInfo(NULL, &ulOutBufLen);
    if (dwRetVal == ERROR_INSUFFICIENT_BUFFER) {
        pInfo = (IP_INTERFACE_INFO *) MALLOC(ulOutBufLen);
        if (pInfo == NULL) {
            printf
                ("Unable to allocate memory needed to call GetInterfaceInfo\n");
            return 1;
        }
    }
// Make a second call to GetInterfaceInfo to get
// the actual data we need
    dwRetVal = GetInterfaceInfo(pInfo, &ulOutBufLen);
    if (dwRetVal == NO_ERROR) {
        printf("Number of Adapters: %ld\n\n", pInfo->NumAdapters);
        for (i = 0; i < pInfo->NumAdapters; i++) {
            printf("Adapter Index[%d]: %ld\n", i,
                   pInfo->Adapter[i].Index);
            printf("Adapter Name[%d]: %ws\n\n", i,
                   pInfo->Adapter[i].Name);
        }
        iReturn = 0;
    } else if (dwRetVal == ERROR_NO_DATA) {
        printf
            ("There are no network adapters with IPv4 enabled on the local system\n");
        iReturn = 0;
    } else {
        printf("GetInterfaceInfo failed with error: %d\n", dwRetVal);
        iReturn = 1;
    }

    FREE(pInfo);
    return (iReturn);
}

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

各言語での呼び出し定義

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

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

GetInterfaceInfo = ctypes.windll.iphlpapi.GetInterfaceInfo
GetInterfaceInfo.restype = wintypes.DWORD
GetInterfaceInfo.argtypes = [
    ctypes.c_void_p,  # pIfTable : IP_INTERFACE_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # dwOutBufLen : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetInterfaceInfo = iphlpapi.NewProc("GetInterfaceInfo")
)

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

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

typedef GetInterfaceInfoNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetInterfaceInfoDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetInterfaceInfo = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetInterfaceInfoNative, GetInterfaceInfoDart>('GetInterfaceInfo');
// pIfTable : IP_INTERFACE_INFO* optional, out -> Pointer<Void>
// dwOutBufLen : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetInterfaceInfo(
  pIfTable: Pointer;   // IP_INTERFACE_INFO* optional, out
  dwOutBufLen: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetInterfaceInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetInterfaceInfo"
  c_GetInterfaceInfo :: Ptr () -> Ptr Word32 -> IO Word32
-- pIfTable : IP_INTERFACE_INFO* optional, out -> Ptr ()
-- dwOutBufLen : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetInterfaceInfo" get-interface-info :convention :stdcall) :uint32
  (p-if-table :pointer)   ; IP_INTERFACE_INFO* optional, out
  (dw-out-buf-len :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetInterfaceInfo = Win32::API::More->new('IPHLPAPI',
    'DWORD GetInterfaceInfo(LPVOID pIfTable, LPVOID dwOutBufLen)');
# my $ret = $GetInterfaceInfo->Call($pIfTable, $dwOutBufLen);
# pIfTable : IP_INTERFACE_INFO* optional, out -> LPVOID
# dwOutBufLen : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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