ホーム › NetworkManagement.IpHelper › ConvertInterfaceLuidToNameA

ConvertInterfaceLuidToNameA

関数

インターフェイスLUIDを名前(ANSI)に変換する。

DLLIPHLPAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// IPHLPAPI.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR ConvertInterfaceLuidToNameA(
    const NET_LUID_LH* InterfaceLuid,
    LPSTR InterfaceName,
    UINT_PTR Length
);

パラメーター

名前	型	方向	説明
InterfaceLuid	NET_LUID_LH*	in	ネットワークインターフェイスの NET_LUID へのポインター。
InterfaceName	LPSTR	out	関数が正常に返ったときに、インターフェイス名を含む NULL 終端の ANSI 文字列を格納するバッファーへのポインター。
Length	UINT_PTR	in	InterfaceName パラメーターが指すバッファーの長さ (バイト単位)。この値は、インターフェイス名と終端の null 文字を格納できる十分な大きさである必要があります。必要となる最大の長さは NDIS_IF_MAX_STRING_SIZE + 1 です。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

成功した場合、 ConvertInterfaceLuidToNameA は NETIO_ERROR_SUCCESS を返します。0 以外の戻り値はいずれも失敗を示します。

エラーコード	意味
ERROR_INVALID_PARAMETER	パラメーターのいずれかが無効でした。このエラーは、InterfaceLuid または InterfaceName パラメーターが NULL であった場合、あるいは InterfaceLuid パラメーターが無効であった場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	このコマンドを処理するために十分な記憶域がありません。このエラーは、InterfaceName パラメーターが指すバッファーのサイズが、Length パラメーターで指定されたとおりにインターフェイス名を格納するには十分な大きさでなかった場合に返されます。

解説(Remarks)

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

ConvertInterfaceLuidToNameA 関数はプロトコルに依存せず、IPv6 と IPv4 の両方のプロトコルのネットワークインターフェイスで動作します。ConvertInterfaceLuidToNameA は、ネットワークインターフェイスの LUID を ANSI のインターフェイス名に変換します。

ConvertInterfaceLuidToNameW は、ネットワークインターフェイスの LUID を Unicode のインターフェイス名に変換します。

終端の NULL を含まないインターフェイス名の最大長 NDIS_IF_MAX_STRING_SIZE は、Ntddndis.h ヘッダーファイルで宣言されています。NDIS_IF_MAX_STRING_SIZE は、Ifdef.h ヘッダーファイルで定義されている IF_MAX_STRING_SIZE 定数として定義されています。Ntddndis.h および Ifdef.h ヘッダーファイルは Netioapi.h ヘッダーファイルに自動的にインクルードされ、Netioapi.h は Iphlpapi.h ヘッダーファイルに自動的にインクルードされます。Ntddndis.h、Ifdef.h、および Netioapi.h ヘッダーファイルを直接使用することは決してしないでください。

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

各言語での呼び出し定義

// IPHLPAPI.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR ConvertInterfaceLuidToNameA(
    const NET_LUID_LH* InterfaceLuid,
    LPSTR InterfaceName,
    UINT_PTR Length
);

[DllImport("IPHLPAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ConvertInterfaceLuidToNameA(
    IntPtr InterfaceLuid,   // NET_LUID_LH*
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder InterfaceName,   // LPSTR out
    UIntPtr Length   // UINT_PTR
);

<DllImport("IPHLPAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ConvertInterfaceLuidToNameA(
    InterfaceLuid As IntPtr,   ' NET_LUID_LH*
    <MarshalAs(UnmanagedType.LPStr)> InterfaceName As System.Text.StringBuilder,   ' LPSTR out
    Length As UIntPtr   ' UINT_PTR
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

ConvertInterfaceLuidToNameA = ctypes.windll.iphlpapi.ConvertInterfaceLuidToNameA
ConvertInterfaceLuidToNameA.restype = wintypes.DWORD
ConvertInterfaceLuidToNameA.argtypes = [
    ctypes.c_void_p,  # InterfaceLuid : NET_LUID_LH*
    wintypes.LPSTR,  # InterfaceName : LPSTR out
    ctypes.c_size_t,  # Length : UINT_PTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
ConvertInterfaceLuidToNameA = Fiddle::Function.new(
  lib['ConvertInterfaceLuidToNameA'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceLuid : NET_LUID_LH*
    Fiddle::TYPE_VOIDP,  # InterfaceName : LPSTR out
    Fiddle::TYPE_UINTPTR_T,  # Length : UINT_PTR
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn ConvertInterfaceLuidToNameA(
        InterfaceLuid: *const NET_LUID_LH,  // NET_LUID_LH*
        InterfaceName: *mut u8,  // LPSTR out
        Length: usize  // UINT_PTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint ConvertInterfaceLuidToNameA(IntPtr InterfaceLuid, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder InterfaceName, UIntPtr Length);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_ConvertInterfaceLuidToNameA' -Namespace Win32 -PassThru
# $api::ConvertInterfaceLuidToNameA(InterfaceLuid, InterfaceName, Length)

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

出力引数:

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