GetIpInterfaceEntry
関数シグネチャ
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR GetIpInterfaceEntry(
MIB_IPINTERFACE_ROW* Row
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| Row | MIB_IPINTERFACE_ROW* | inout | MIB_IPINTERFACE_ROW 構造体へのポインター。正常に復帰すると、ローカルコンピューター上のインターフェイスの情報を受け取ります。入力時には、MIB_IPINTERFACE_ROW の InterfaceLuid メンバーまたは InterfaceIndex メンバーに、情報を取得する対象のインターフェイスを設定しておく必要があります。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
ローカルコンピューター上の指定されたインターフェイスの IP 情報を取得します。
戻り値
関数が成功した場合、戻り値は NO_ERROR です。
関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。
| 戻り値コード | 説明 |
|---|---|
| 指定されたファイルが見つかりません。このエラーは、Row パラメーターが指す MIB_IPINTERFACE_ROW の InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたネットワークインターフェイスの LUID またはインターフェイスインデックスが、ローカルマシン上の値ではなかった場合に返されます。 | |
| 無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPINTERFACE_ROW の Family メンバーが AF_INET または AF_INET6 として指定されていなかった場合、あるいは Row パラメーターが指す MIB_IPINTERFACE_ROW の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が未指定だった場合に返されます。 | |
| 要素が見つかりません。このエラーは、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されたネットワークインターフェイスが、MIB_IPINTERFACE_ROW 構造体の Family メンバーで指定された IP アドレスファミリーと一致しない場合に返されます。 | |
|
返されたエラーのメッセージ文字列を取得するには、FormatMessage 関数を使用してください。 |
解説(Remarks)
GetIpInterfaceEntry 関数は Windows Vista 以降で定義されています。
入力時には、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の Family メンバーを AF_INET または AF_INET6 のいずれかに初期化しておく必要があります。さらに入力時には、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の InterfaceLuid または InterfaceIndex のうち、少なくとも 1 つのメンバーを初期化しておく必要があります。
これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが特定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値が 0 に設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが特定されます。
出力時には、InterfaceIndex が指定されていた場合、Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体の InterfaceLuid メンバーが設定されます。Row パラメーターが指す MIB_IPINTERFACE_ROW 構造体のその他のメンバーも設定されます。
MIB_IPINTERFACE_ROW 構造体エントリのフィールドを既定値で初期化するには、InitializeIpInterfaceEntry 関数を使用する必要があります。その後、アプリケーションは MIB_IPINTERFACE_ROW エントリ内の変更したいフィールドを変更してから、SetIpInterfaceEntry 関数を呼び出すことができます。
セキュリティ要件が異なる複数のネットワークへ非特権で同時にアクセスできると、セキュリティホールが生じ、非特権アプリケーションが 2 つのネットワーク間で誤ってデータを中継してしまう可能性があります。典型的な例は、仮想プライベートネットワーク(VPN)とインターネットへの同時アクセスです。Windows Server 2003 および Windows XP では弱いホストモデルが使用されており、RAS は他のインターフェイス上のすべての既定ルートのルートメトリックを増加させることで、このような同時アクセスを防止します。これにより、すべてのトラフィックが VPN インターフェイス経由でルーティングされ、他のネットワーク接続が妨げられます。
Windows Vista 以降では、既定で強いホストモデルが使用されます。GetBestRoute2 または GetBestRoute を使用するルート検索で送信元 IP アドレスを指定すると、ルート検索はその送信元 IP アドレスのインターフェイスに限定されます。潜在的なルートの一覧に VPN インターフェイスのルートさえ含まれなくなるため、RAS によるルートメトリックの変更は効果がなくなり、インターネットへのトラフィックが許可されます。MIB_IPINTERFACE_ROW の DisableDefaultRoutes メンバーを使用すると、インターフェイス上で既定ルートを使用しないように無効化できます。このメンバーは、VPN クライアントがスプリットトンネリングを必要としない場合に、スプリットトンネリングを制限するためのセキュリティ対策として使用できます。VPN クライアントは、必要に応じて SetIpInterfaceEntry 関数を呼び出して DisableDefaultRoutes メンバーを TRUE に設定できます。VPN クライアントは、GetIpInterfaceEntry 関数を呼び出すことで DisableDefaultRoutes メンバーの現在の状態を照会できます。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll
#include <windows.h>
WIN32_ERROR GetIpInterfaceEntry(
MIB_IPINTERFACE_ROW* Row
);[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIpInterfaceEntry(
IntPtr Row // MIB_IPINTERFACE_ROW* in/out
);<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIpInterfaceEntry(
Row As IntPtr ' MIB_IPINTERFACE_ROW* in/out
) As UInteger
End Function' Row : MIB_IPINTERFACE_ROW* in/out
Declare PtrSafe Function GetIpInterfaceEntry Lib "iphlpapi" ( _
ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetIpInterfaceEntry = ctypes.windll.iphlpapi.GetIpInterfaceEntry
GetIpInterfaceEntry.restype = wintypes.DWORD
GetIpInterfaceEntry.argtypes = [
ctypes.c_void_p, # Row : MIB_IPINTERFACE_ROW* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
GetIpInterfaceEntry = Fiddle::Function.new(
lib['GetIpInterfaceEntry'],
[
Fiddle::TYPE_VOIDP, # Row : MIB_IPINTERFACE_ROW* in/out
],
-Fiddle::TYPE_INT)#[link(name = "iphlpapi")]
extern "system" {
fn GetIpInterfaceEntry(
Row: *mut MIB_IPINTERFACE_ROW // MIB_IPINTERFACE_ROW* in/out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetIpInterfaceEntry(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetIpInterfaceEntry' -Namespace Win32 -PassThru
# $api::GetIpInterfaceEntry(Row)#uselib "IPHLPAPI.dll"
#func global GetIpInterfaceEntry "GetIpInterfaceEntry" sptr
; GetIpInterfaceEntry varptr(Row) ; 戻り値は stat
; Row : MIB_IPINTERFACE_ROW* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global GetIpInterfaceEntry "GetIpInterfaceEntry" var ; res = GetIpInterfaceEntry(Row) ; Row : MIB_IPINTERFACE_ROW* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global GetIpInterfaceEntry "GetIpInterfaceEntry" sptr ; res = GetIpInterfaceEntry(varptr(Row)) ; Row : MIB_IPINTERFACE_ROW* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; WIN32_ERROR GetIpInterfaceEntry(MIB_IPINTERFACE_ROW* Row) #uselib "IPHLPAPI.dll" #cfunc global GetIpInterfaceEntry "GetIpInterfaceEntry" var ; res = GetIpInterfaceEntry(Row) ; Row : MIB_IPINTERFACE_ROW* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR GetIpInterfaceEntry(MIB_IPINTERFACE_ROW* Row) #uselib "IPHLPAPI.dll" #cfunc global GetIpInterfaceEntry "GetIpInterfaceEntry" intptr ; res = GetIpInterfaceEntry(varptr(Row)) ; Row : MIB_IPINTERFACE_ROW* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procGetIpInterfaceEntry = iphlpapi.NewProc("GetIpInterfaceEntry")
)
// Row (MIB_IPINTERFACE_ROW* in/out)
r1, _, err := procGetIpInterfaceEntry.Call(
uintptr(Row),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction GetIpInterfaceEntry(
Row: Pointer // MIB_IPINTERFACE_ROW* in/out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetIpInterfaceEntry';result := DllCall("IPHLPAPI\GetIpInterfaceEntry"
, "Ptr", Row ; MIB_IPINTERFACE_ROW* in/out
, "UInt") ; return: WIN32_ERROR●GetIpInterfaceEntry(Row) = DLL("IPHLPAPI.dll", "dword GetIpInterfaceEntry(void*)")
# 呼び出し: GetIpInterfaceEntry(Row)
# Row : MIB_IPINTERFACE_ROW* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "iphlpapi" fn GetIpInterfaceEntry(
Row: [*c]MIB_IPINTERFACE_ROW // MIB_IPINTERFACE_ROW* in/out
) callconv(std.os.windows.WINAPI) u32;proc GetIpInterfaceEntry(
Row: ptr MIB_IPINTERFACE_ROW # MIB_IPINTERFACE_ROW* in/out
): uint32 {.importc: "GetIpInterfaceEntry", stdcall, dynlib: "IPHLPAPI.dll".}pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpInterfaceEntry(
MIB_IPINTERFACE_ROW* Row // MIB_IPINTERFACE_ROW* in/out
);ccall((:GetIpInterfaceEntry, "IPHLPAPI.dll"), stdcall, UInt32,
(Ptr{MIB_IPINTERFACE_ROW},),
Row)
# Row : MIB_IPINTERFACE_ROW* in/out -> Ptr{MIB_IPINTERFACE_ROW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpInterfaceEntry(
void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpInterfaceEntry(Row)
-- Row : MIB_IPINTERFACE_ROW* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpInterfaceEntry = lib.func('__stdcall', 'GetIpInterfaceEntry', 'uint32_t', ['void *']);
// GetIpInterfaceEntry(Row)
// Row : MIB_IPINTERFACE_ROW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
GetIpInterfaceEntry: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetIpInterfaceEntry(Row)
// Row : MIB_IPINTERFACE_ROW* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpInterfaceEntry(
void* Row);
C, "IPHLPAPI.dll");
// $ffi->GetIpInterfaceEntry(Row);
// Row : MIB_IPINTERFACE_ROW* 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 GetIpInterfaceEntry(
Pointer Row // MIB_IPINTERFACE_ROW* in/out
);
}@[Link("iphlpapi")]
lib LibIPHLPAPI
fun GetIpInterfaceEntry = GetIpInterfaceEntry(
Row : MIB_IPINTERFACE_ROW* # MIB_IPINTERFACE_ROW* 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 GetIpInterfaceEntryNative = Uint32 Function(Pointer<Void>);
typedef GetIpInterfaceEntryDart = int Function(Pointer<Void>);
final GetIpInterfaceEntry = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<GetIpInterfaceEntryNative, GetIpInterfaceEntryDart>('GetIpInterfaceEntry');
// Row : MIB_IPINTERFACE_ROW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetIpInterfaceEntry(
Row: Pointer // MIB_IPINTERFACE_ROW* in/out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'GetIpInterfaceEntry';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetIpInterfaceEntry"
c_GetIpInterfaceEntry :: Ptr () -> IO Word32
-- Row : MIB_IPINTERFACE_ROW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getipinterfaceentry =
foreign "GetIpInterfaceEntry"
((ptr void) @-> returning uint32_t)
(* Row : MIB_IPINTERFACE_ROW* 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 ("GetIpInterfaceEntry" get-ip-interface-entry :convention :stdcall) :uint32
(row :pointer)) ; MIB_IPINTERFACE_ROW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetIpInterfaceEntry = Win32::API::More->new('IPHLPAPI',
'DWORD GetIpInterfaceEntry(LPVOID Row)');
# my $ret = $GetIpInterfaceEntry->Call($Row);
# Row : MIB_IPINTERFACE_ROW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f GetBestRoute — 指定宛先・送信元IPv4アドレスに最適な経路を取得する。
- f GetBestRoute2 — 指定送信元・宛先アドレスに最適な経路と送信元を取得する。
- f GetIfEntry2 — 指定ネットワークインターフェイスの詳細情報を取得する。
- f GetIfTable2 — 全ネットワークインターフェイスの詳細情報テーブルを取得する。
- f GetIfTable2Ex — 指定レベルで全インターフェイスの詳細情報テーブルを取得する。
- f GetIpInterfaceTable — 指定アドレスファミリのIPインターフェイス構成テーブルを取得する。
- s MIB_IF_ROW2
- s MIB_IF_TABLE2
- s MIB_IPINTERFACE_TABLE
- f SetIpInterfaceEntry — 指定IPインターフェイスの構成情報を設定する。