ホーム › NetworkManagement.IpHelper › GetAdapterIndex

GetAdapterIndex

関数

アダプター名から対応するインターフェイス索引を取得する。

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

シグネチャ

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

DWORD GetAdapterIndex(
    LPWSTR AdapterName,
    DWORD* IfIndex
);

パラメーター

名前	型	方向	説明
AdapterName	LPWSTR	in	アダプターの名前を指定する Unicode 文字列へのポインターです。
IfIndex	DWORD*	inout	アダプターのインデックスを指す ULONG 変数へのポインターです。

戻り値の型: DWORD

公式ドキュメント

GetAdapterIndex 関数は、アダプターの名前を指定して、そのアダプターのインデックスを取得します。

戻り値

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

関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

アダプターが完全に無効化されるまで、GetAdapterIndex 関数はそのアダプターを存在するものとして報告します。たとえば、NotifyAddrChange 関数は最近無効化されたアダプターの IP アドレスが削除されたことを示す場合がありますが、GetAdapterIndex はアダプターを無効化する処理が完了するまでアダプターのインデックスを報告し続けます。

システムに 1 つ以上のアダプターが存在する場合、クエリ対象のアダプターが存在しないと、GetAdapterIndex は ERROR_DEV_NOT_EXIST を返します。アダプターが 1 つも存在しない場合、GetAdapterIndex 関数は ERROR_NO_DATA を返します。

アダプターのインデックスは、アダプターが無効化されてから再度有効化されたときや、その他の状況で変化することがあるため、永続的なものと見なすべきではありません。

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

各言語での呼び出し定義

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

DWORD GetAdapterIndex(
    LPWSTR AdapterName,
    DWORD* IfIndex
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetAdapterIndex(
    [MarshalAs(UnmanagedType.LPWStr)] string AdapterName,   // LPWSTR
    ref uint IfIndex   // DWORD* in/out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetAdapterIndex(
    <MarshalAs(UnmanagedType.LPWStr)> AdapterName As String,   ' LPWSTR
    ByRef IfIndex As UInteger   ' DWORD* in/out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

GetAdapterIndex = ctypes.windll.iphlpapi.GetAdapterIndex
GetAdapterIndex.restype = wintypes.DWORD
GetAdapterIndex.argtypes = [
    wintypes.LPCWSTR,  # AdapterName : LPWSTR
    ctypes.POINTER(wintypes.DWORD),  # IfIndex : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetAdapterIndex = Fiddle::Function.new(
  lib['GetAdapterIndex'],
  [
    Fiddle::TYPE_VOIDP,  # AdapterName : LPWSTR
    Fiddle::TYPE_VOIDP,  # IfIndex : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetAdapterIndex([MarshalAs(UnmanagedType.LPWStr)] string AdapterName, ref uint IfIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetAdapterIndex' -Namespace Win32 -PassThru
# $api::GetAdapterIndex(AdapterName, IfIndex)

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

出力引数:

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