ホーム › NetworkManagement.IpHelper › ConvertInterfaceIndexToLuid

ConvertInterfaceIndexToLuid

関数

インターフェイス索引をLUIDに変換する。

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

シグネチャ

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

WIN32_ERROR ConvertInterfaceIndexToLuid(
    DWORD InterfaceIndex,
    NET_LUID_LH* InterfaceLuid
);

パラメーター

名前	型	方向	説明
InterfaceIndex	DWORD	in	ネットワークインターフェイスのローカルインデックス値。
InterfaceLuid	NET_LUID_LH*	out	このインターフェイスの NET_LUID へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

ネットワークインターフェイスのローカルインデックスを、そのインターフェイスのローカル一意識別子 (LUID) に変換します。

戻り値

成功した場合、 ConvertInterfaceIndexToLuid は NO_ERROR を返します。0 以外の戻り値はすべて失敗を示し、InterfaceLuid パラメーターには NULL が返されます。

エラーコード	意味
ERROR_FILE_NOT_FOUND	指定されたファイルが見つかりません。このエラーは、InterfaceIndex パラメーターで指定されたネットワークインターフェイスがローカルマシン上の値ではなかった場合に返されます。
ERROR_INVALID_PARAMETER	パラメーターのいずれかが無効でした。このエラーは、InterfaceLuid パラメーターが NULL であった場合、または InterfaceIndex パラメーターが無効であった場合に返されます。

解説(Remarks)

ConvertInterfaceIndexToLuid 関数は Windows Vista 以降で使用できます。

ConvertInterfaceIndexToLuid 関数はプロトコルに依存せず、IPv6 と IPv4 の両方のプロトコルのネットワークインターフェイスで機能します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ConvertInterfaceIndexToLuid(
    DWORD InterfaceIndex,
    NET_LUID_LH* InterfaceLuid
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint ConvertInterfaceIndexToLuid(
    uint InterfaceIndex,   // DWORD
    IntPtr InterfaceLuid   // NET_LUID_LH* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function ConvertInterfaceIndexToLuid(
    InterfaceIndex As UInteger,   ' DWORD
    InterfaceLuid As IntPtr   ' NET_LUID_LH* out
) As UInteger
End Function

' InterfaceIndex : DWORD
' InterfaceLuid : NET_LUID_LH* out
Declare PtrSafe Function ConvertInterfaceIndexToLuid Lib "iphlpapi" ( _
    ByVal InterfaceIndex As Long, _
    ByVal InterfaceLuid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ConvertInterfaceIndexToLuid = ctypes.windll.iphlpapi.ConvertInterfaceIndexToLuid
ConvertInterfaceIndexToLuid.restype = wintypes.DWORD
ConvertInterfaceIndexToLuid.argtypes = [
    wintypes.DWORD,  # InterfaceIndex : DWORD
    ctypes.c_void_p,  # InterfaceLuid : NET_LUID_LH* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
ConvertInterfaceIndexToLuid = Fiddle::Function.new(
  lib['ConvertInterfaceIndexToLuid'],
  [
    -Fiddle::TYPE_INT,  # InterfaceIndex : DWORD
    Fiddle::TYPE_VOIDP,  # InterfaceLuid : NET_LUID_LH* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn ConvertInterfaceIndexToLuid(
        InterfaceIndex: u32,  // DWORD
        InterfaceLuid: *mut NET_LUID_LH  // NET_LUID_LH* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint ConvertInterfaceIndexToLuid(uint InterfaceIndex, IntPtr InterfaceLuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_ConvertInterfaceIndexToLuid' -Namespace Win32 -PassThru
# $api::ConvertInterfaceIndexToLuid(InterfaceIndex, InterfaceLuid)

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

出力引数:

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