ホーム › NetworkManagement.IpHelper › GetPerAdapterInfo

GetPerAdapterInfo

関数

指定インターフェイス固有のDNS等の情報を取得する。

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

シグネチャ

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

DWORD GetPerAdapterInfo(
    DWORD IfIndex,
    IP_PER_ADAPTER_INFO_W2KSP1* pPerAdapterInfo,   // optional
    DWORD* pOutBufLen
);

パラメーター

名前	型	方向	説明
IfIndex	DWORD	in	インターフェイスのインデックスです。 GetPerAdapterInfo 関数は、このインターフェイスに対応するアダプターの情報を取得します。
pPerAdapterInfo	IP_PER_ADAPTER_INFO_W2KSP1*	outoptional	アダプターの情報を受け取る IP_PER_ADAPTER_INFO 構造体へのポインターです。
pOutBufLen	DWORD*	inout	IP_PER_ADAPTER_INFO 構造体のサイズを指定する ULONG 変数へのポインターです。このサイズが情報を格納するのに不十分な場合、 GetPerAdapterInfo はこの変数に必要なサイズを設定し、エラーコード ERROR_BUFFER_OVERFLOW を返します。

戻り値の型: DWORD

公式ドキュメント

GetPerAdapterInfo 関数は、指定したインターフェイスに対応するアダプターの情報を取得します。

戻り値

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

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

戻り値	説明
ERROR_BUFFER_OVERFLOW	pOutBufLen パラメーターで指定されたバッファーサイズが、アダプター情報を格納するには小さすぎます。pOutBufLen パラメーターは必要なサイズを指します。
ERROR_INVALID_PARAMETER	pOutBufLen パラメーターが NULL であるか、呼び出し元のプロセスが pOutBufLen が指すメモリへの読み取り/書き込みアクセス権を持っていないか、あるいは呼び出し元のプロセスが pAdapterInfo パラメーターが指すメモリへの書き込みアクセス権を持っていません。
ERROR_NOT_SUPPORTED	GetPerAdapterInfo は、ローカルコンピューターで実行されているオペレーティングシステムではサポートされていません。
その他	関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

アダプターのインデックスは、アダプターが無効化された後に再び有効化されたときや、その他の状況で変化することがあります。永続的なものとは見なさないでください。

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

各言語での呼び出し定義

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

DWORD GetPerAdapterInfo(
    DWORD IfIndex,
    IP_PER_ADAPTER_INFO_W2KSP1* pPerAdapterInfo,   // optional
    DWORD* pOutBufLen
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetPerAdapterInfo(
    uint IfIndex,   // DWORD
    IntPtr pPerAdapterInfo,   // IP_PER_ADAPTER_INFO_W2KSP1* optional, out
    ref uint pOutBufLen   // DWORD* in/out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetPerAdapterInfo(
    IfIndex As UInteger,   ' DWORD
    pPerAdapterInfo As IntPtr,   ' IP_PER_ADAPTER_INFO_W2KSP1* optional, out
    ByRef pOutBufLen As UInteger   ' DWORD* in/out
) As UInteger
End Function

' IfIndex : DWORD
' pPerAdapterInfo : IP_PER_ADAPTER_INFO_W2KSP1* optional, out
' pOutBufLen : DWORD* in/out
Declare PtrSafe Function GetPerAdapterInfo Lib "iphlpapi" ( _
    ByVal IfIndex As Long, _
    ByVal pPerAdapterInfo As LongPtr, _
    ByRef pOutBufLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPerAdapterInfo = ctypes.windll.iphlpapi.GetPerAdapterInfo
GetPerAdapterInfo.restype = wintypes.DWORD
GetPerAdapterInfo.argtypes = [
    wintypes.DWORD,  # IfIndex : DWORD
    ctypes.c_void_p,  # pPerAdapterInfo : IP_PER_ADAPTER_INFO_W2KSP1* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pOutBufLen : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetPerAdapterInfo = Fiddle::Function.new(
  lib['GetPerAdapterInfo'],
  [
    -Fiddle::TYPE_INT,  # IfIndex : DWORD
    Fiddle::TYPE_VOIDP,  # pPerAdapterInfo : IP_PER_ADAPTER_INFO_W2KSP1* optional, out
    Fiddle::TYPE_VOIDP,  # pOutBufLen : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetPerAdapterInfo(
        IfIndex: u32,  // DWORD
        pPerAdapterInfo: *mut IP_PER_ADAPTER_INFO_W2KSP1,  // IP_PER_ADAPTER_INFO_W2KSP1* optional, out
        pOutBufLen: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetPerAdapterInfo(uint IfIndex, IntPtr pPerAdapterInfo, ref uint pOutBufLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetPerAdapterInfo' -Namespace Win32 -PassThru
# $api::GetPerAdapterInfo(IfIndex, pPerAdapterInfo, pOutBufLen)

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

出力引数:

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