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

GetIfEntry2Ex

関数
指定レベルでネットワークインターフェイスの詳細情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

WIN32_ERROR GetIfEntry2Ex(
    MIB_IF_ENTRY_LEVEL Level,
    MIB_IF_ROW2* Row
);

パラメーター

名前方向説明
LevelMIB_IF_ENTRY_LEVELin

取得するインターフェイス情報のレベル。このパラメーターには、Netioapi.h ヘッダーファイルで定義されている MIB_IF_ENTRY_LEVEL 列挙型の値のいずれかを指定できます。

意味
MibIfEntryNormal
0
Row パラメーターが指する MIB_IF_ROW2 構造体のメンバーに返される統計情報と状態の値は、フィルタースタックの最上位から取得されます。
MibIfEntryNormalWithoutStatistics
2
Row パラメーターが指す MIB_IF_ROW2 構造体のメンバーに返される状態の値(統計情報なし)は、フィルタースタックの最上位から取得されます。
RowMIB_IF_ROW2*inoutMIB_IF_ROW2 構造体へのポインター。正常に復帰すると、ローカルコンピューター上のインターフェイスの情報を受け取ります。入力時には、情報を取得する対象のインターフェイスを示すように、MIB_IF_ROW2InterfaceLuid メンバーまたは InterfaceIndex メンバーを設定しておく必要があります。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の指定したインターフェイスについて、指定したレベルの情報を取得します。

戻り値

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

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

戻り値 説明
ERROR_FILE_NOT_FOUND
指定されたファイルが見つかりません。このエラーは、Row パラメーターが指す MIB_IF_ROW2InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたネットワークインターフェイスの LUID またはインターフェイスインデックスが、ローカルマシンに存在する値でなかった場合に返されます。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL パラメーターが渡された場合に返されます。また、Row パラメーターが指す MIB_IF_ROW2InterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていない場合にも返されます。
その他
返されたエラーのメッセージ文字列を取得するには、FormatMessage 関数を使用してください。

解説(Remarks)

GetIfEntry2Ex 関数は、ローカルシステム上の指定したインターフェイスの情報を取得し、その情報を MIB_IF_ROW2 構造体へのポインターに格納して返します。GetIfEntry2ExGetIfEntry2 関数の拡張版であり、取得するインターフェイス情報のレベルを選択できます。

入力時には、Row パラメーターに渡す MIB_IF_ROW2 構造体の次のメンバーのうち、少なくとも 1 つを初期化しておく必要があります。InterfaceLuid または InterfaceIndex です。

これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが特定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値が 0 に設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが特定されます。

出力時には、Row パラメーターが指す MIB_IF_ROW2 構造体の残りのフィールドが設定されます。

なお、Netioapi.h ヘッダーファイルは Iphlpapi.h ヘッダーファイルに自動的にインクルードされるため、直接使用すべきではありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIfEntry2Ex(
    MIB_IF_ENTRY_LEVEL Level,
    MIB_IF_ROW2* Row
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIfEntry2Ex(
    int Level,   // MIB_IF_ENTRY_LEVEL
    IntPtr Row   // MIB_IF_ROW2* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIfEntry2Ex(
    Level As Integer,   ' MIB_IF_ENTRY_LEVEL
    Row As IntPtr   ' MIB_IF_ROW2* in/out
) As UInteger
End Function
' Level : MIB_IF_ENTRY_LEVEL
' Row : MIB_IF_ROW2* in/out
Declare PtrSafe Function GetIfEntry2Ex Lib "iphlpapi" ( _
    ByVal Level As Long, _
    ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIfEntry2Ex = ctypes.windll.iphlpapi.GetIfEntry2Ex
GetIfEntry2Ex.restype = wintypes.DWORD
GetIfEntry2Ex.argtypes = [
    ctypes.c_int,  # Level : MIB_IF_ENTRY_LEVEL
    ctypes.c_void_p,  # Row : MIB_IF_ROW2* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIfEntry2Ex = iphlpapi.NewProc("GetIfEntry2Ex")
)

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

extern "iphlpapi" fn GetIfEntry2Ex(
    Level: i32, // MIB_IF_ENTRY_LEVEL
    Row: [*c]MIB_IF_ROW2 // MIB_IF_ROW2* in/out
) callconv(std.os.windows.WINAPI) u32;
proc GetIfEntry2Ex(
    Level: int32,  # MIB_IF_ENTRY_LEVEL
    Row: ptr MIB_IF_ROW2  # MIB_IF_ROW2* in/out
): uint32 {.importc: "GetIfEntry2Ex", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIfEntry2Ex(
    int Level,   // MIB_IF_ENTRY_LEVEL
    MIB_IF_ROW2* Row   // MIB_IF_ROW2* in/out
);
ccall((:GetIfEntry2Ex, "IPHLPAPI.dll"), stdcall, UInt32,
      (Int32, Ptr{MIB_IF_ROW2}),
      Level, Row)
# Level : MIB_IF_ENTRY_LEVEL -> Int32
# Row : MIB_IF_ROW2* in/out -> Ptr{MIB_IF_ROW2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIfEntry2Ex(
    int32_t Level,
    void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIfEntry2Ex(Level, Row)
-- Level : MIB_IF_ENTRY_LEVEL
-- Row : MIB_IF_ROW2* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIfEntry2Ex = lib.func('__stdcall', 'GetIfEntry2Ex', 'uint32_t', ['int32_t', 'void *']);
// GetIfEntry2Ex(Level, Row)
// Level : MIB_IF_ENTRY_LEVEL -> 'int32_t'
// Row : MIB_IF_ROW2* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIfEntry2Ex: { parameters: ["i32", "pointer"], result: "u32" },
});
// lib.symbols.GetIfEntry2Ex(Level, Row)
// Level : MIB_IF_ENTRY_LEVEL -> "i32"
// Row : MIB_IF_ROW2* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIfEntry2Ex(
    int32_t Level,
    void* Row);
C, "IPHLPAPI.dll");
// $ffi->GetIfEntry2Ex(Level, Row);
// Level : MIB_IF_ENTRY_LEVEL
// Row : MIB_IF_ROW2* 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 GetIfEntry2Ex(
        int Level,   // MIB_IF_ENTRY_LEVEL
        Pointer Row   // MIB_IF_ROW2* in/out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIfEntry2Ex = GetIfEntry2Ex(
    Level : Int32,   # MIB_IF_ENTRY_LEVEL
    Row : MIB_IF_ROW2*   # MIB_IF_ROW2* 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 GetIfEntry2ExNative = Uint32 Function(Int32, Pointer<Void>);
typedef GetIfEntry2ExDart = int Function(int, Pointer<Void>);
final GetIfEntry2Ex = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIfEntry2ExNative, GetIfEntry2ExDart>('GetIfEntry2Ex');
// Level : MIB_IF_ENTRY_LEVEL -> Int32
// Row : MIB_IF_ROW2* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIfEntry2Ex(
  Level: Integer;   // MIB_IF_ENTRY_LEVEL
  Row: Pointer   // MIB_IF_ROW2* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIfEntry2Ex';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIfEntry2Ex"
  c_GetIfEntry2Ex :: Int32 -> Ptr () -> IO Word32
-- Level : MIB_IF_ENTRY_LEVEL -> Int32
-- Row : MIB_IF_ROW2* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getifentry2ex =
  foreign "GetIfEntry2Ex"
    (int32_t @-> (ptr void) @-> returning uint32_t)
(* Level : MIB_IF_ENTRY_LEVEL -> int32_t *)
(* Row : MIB_IF_ROW2* in/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 ("GetIfEntry2Ex" get-if-entry2-ex :convention :stdcall) :uint32
  (level :int32)   ; MIB_IF_ENTRY_LEVEL
  (row :pointer))   ; MIB_IF_ROW2* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIfEntry2Ex = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIfEntry2Ex(int Level, LPVOID Row)');
# my $ret = $GetIfEntry2Ex->Call($Level, $Row);
# Level : MIB_IF_ENTRY_LEVEL -> int
# Row : MIB_IF_ROW2* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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