Win32 API 日本語リファレンス
ホーム › NetworkManagement.IpHelper › ConvertInterfaceNameToLuidA

ConvertInterfaceNameToLuidA

関数
インターフェイス名(ANSI)をLUIDに変換する。
DLLIPHLPAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR ConvertInterfaceNameToLuidA(
    LPCSTR InterfaceName,
    NET_LUID_LH* InterfaceLuid
);

パラメーター

名前型方向説明
InterfaceNameLPCSTRinネットワークインターフェイス名を格納した NULL 終端の ANSI 文字列へのポインター。
InterfaceLuidNET_LUID_LH*outこのインターフェイスの NET_LUID へのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

成功した場合、 ConvertInterfaceNameToLuidA は NETIO_ERROR_SUCCESS を返します。0 以外の戻り値はすべて失敗を示します。

エラーコード 意味
ERROR_BUFFER_OVERFLOW
 ANSI インターフェイス名の長さが無効です。InterfaceName パラメーターがこのパラメーターで許可される最大文字列長を超えた場合に、このエラーが返されます。
ERROR_INVALID_NAME
 インターフェイス名が無効です。InterfaceName パラメーターに無効な名前が含まれていた場合に、このエラーが返されます。
ERROR_INVALID_PARAMETER
 パラメーターのいずれかが無効です。InterfaceLuid パラメーターが NULL であった場合に、このエラーが返されます。

解説(Remarks)

ConvertInterfaceNameToLuidA 関数は Windows Vista 以降で利用できます。

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

ConvertInterfaceNameToLuidW は Unicode のインターフェイス名を LUID に変換します。

終端の 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 ConvertInterfaceNameToLuidA(
    LPCSTR InterfaceName,
    NET_LUID_LH* InterfaceLuid
);
[DllImport("IPHLPAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ConvertInterfaceNameToLuidA(
    [MarshalAs(UnmanagedType.LPStr)] string InterfaceName,   // LPCSTR
    IntPtr InterfaceLuid   // NET_LUID_LH* out
);
<DllImport("IPHLPAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ConvertInterfaceNameToLuidA(
    <MarshalAs(UnmanagedType.LPStr)> InterfaceName As String,   ' LPCSTR
    InterfaceLuid As IntPtr   ' NET_LUID_LH* out
) As UInteger
End Function
' InterfaceName : LPCSTR
' InterfaceLuid : NET_LUID_LH* out
Declare PtrSafe Function ConvertInterfaceNameToLuidA Lib "iphlpapi" ( _
    ByVal InterfaceName As String, _
    ByVal InterfaceLuid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ConvertInterfaceNameToLuidA = ctypes.windll.iphlpapi.ConvertInterfaceNameToLuidA
ConvertInterfaceNameToLuidA.restype = wintypes.DWORD
ConvertInterfaceNameToLuidA.argtypes = [
    wintypes.LPCSTR,  # InterfaceName : LPCSTR
    ctypes.c_void_p,  # InterfaceLuid : NET_LUID_LH* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
ConvertInterfaceNameToLuidA = Fiddle::Function.new(
  lib['ConvertInterfaceNameToLuidA'],
  [
    Fiddle::TYPE_VOIDP,  # InterfaceName : LPCSTR
    Fiddle::TYPE_VOIDP,  # InterfaceLuid : NET_LUID_LH* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn ConvertInterfaceNameToLuidA(
        InterfaceName: *const u8,  // LPCSTR
        InterfaceLuid: *mut NET_LUID_LH  // NET_LUID_LH* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint ConvertInterfaceNameToLuidA([MarshalAs(UnmanagedType.LPStr)] string InterfaceName, IntPtr InterfaceLuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_ConvertInterfaceNameToLuidA' -Namespace Win32 -PassThru
# $api::ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
#uselib "IPHLPAPI.dll"
#func global ConvertInterfaceNameToLuidA "ConvertInterfaceNameToLuidA" sptr, sptr
; ConvertInterfaceNameToLuidA InterfaceName, varptr(InterfaceLuid)   ; 戻り値は stat
; InterfaceName : LPCSTR -> "sptr"
; InterfaceLuid : NET_LUID_LH* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "IPHLPAPI.dll"
#cfunc global ConvertInterfaceNameToLuidA "ConvertInterfaceNameToLuidA" str, var
; res = ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
; InterfaceName : LPCSTR -> "str"
; InterfaceLuid : NET_LUID_LH* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; WIN32_ERROR ConvertInterfaceNameToLuidA(LPCSTR InterfaceName, NET_LUID_LH* InterfaceLuid)
#uselib "IPHLPAPI.dll"
#cfunc global ConvertInterfaceNameToLuidA "ConvertInterfaceNameToLuidA" str, var
; res = ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
; InterfaceName : LPCSTR -> "str"
; InterfaceLuid : NET_LUID_LH* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procConvertInterfaceNameToLuidA = iphlpapi.NewProc("ConvertInterfaceNameToLuidA")
)

// InterfaceName (LPCSTR), InterfaceLuid (NET_LUID_LH* out)
r1, _, err := procConvertInterfaceNameToLuidA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(InterfaceName))),
	uintptr(InterfaceLuid),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function ConvertInterfaceNameToLuidA(
  InterfaceName: PAnsiChar;   // LPCSTR
  InterfaceLuid: Pointer   // NET_LUID_LH* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'ConvertInterfaceNameToLuidA';
result := DllCall("IPHLPAPI\ConvertInterfaceNameToLuidA"
    , "AStr", InterfaceName   ; LPCSTR
    , "Ptr", InterfaceLuid   ; NET_LUID_LH* out
    , "UInt")   ; return: WIN32_ERROR
●ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid) = DLL("IPHLPAPI.dll", "dword ConvertInterfaceNameToLuidA(char*, void*)")
# 呼び出し: ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
# InterfaceName : LPCSTR -> "char*"
# InterfaceLuid : NET_LUID_LH* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn ConvertInterfaceNameToLuidA(
    InterfaceName: [*c]const u8, // LPCSTR
    InterfaceLuid: [*c]NET_LUID_LH // NET_LUID_LH* out
) callconv(std.os.windows.WINAPI) u32;
proc ConvertInterfaceNameToLuidA(
    InterfaceName: cstring,  # LPCSTR
    InterfaceLuid: ptr NET_LUID_LH  # NET_LUID_LH* out
): uint32 {.importc: "ConvertInterfaceNameToLuidA", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint ConvertInterfaceNameToLuidA(
    const(char)* InterfaceName,   // LPCSTR
    NET_LUID_LH* InterfaceLuid   // NET_LUID_LH* out
);
ccall((:ConvertInterfaceNameToLuidA, "IPHLPAPI.dll"), stdcall, UInt32,
      (Cstring, Ptr{NET_LUID_LH}),
      InterfaceName, InterfaceLuid)
# InterfaceName : LPCSTR -> Cstring
# InterfaceLuid : NET_LUID_LH* out -> Ptr{NET_LUID_LH}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ConvertInterfaceNameToLuidA(
    const char* InterfaceName,
    void* InterfaceLuid);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
-- InterfaceName : LPCSTR
-- InterfaceLuid : NET_LUID_LH* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const ConvertInterfaceNameToLuidA = lib.func('__stdcall', 'ConvertInterfaceNameToLuidA', 'uint32_t', ['str', 'void *']);
// ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
// InterfaceName : LPCSTR -> 'str'
// InterfaceLuid : NET_LUID_LH* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  ConvertInterfaceNameToLuidA: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid)
// InterfaceName : LPCSTR -> "buffer"
// InterfaceLuid : NET_LUID_LH* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ConvertInterfaceNameToLuidA(
    const char* InterfaceName,
    void* InterfaceLuid);
C, "IPHLPAPI.dll");
// $ffi->ConvertInterfaceNameToLuidA(InterfaceName, InterfaceLuid);
// InterfaceName : LPCSTR
// InterfaceLuid : NET_LUID_LH* 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, W32APIOptions.ASCII_OPTIONS);
    int ConvertInterfaceNameToLuidA(
        String InterfaceName,   // LPCSTR
        Pointer InterfaceLuid   // NET_LUID_LH* out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun ConvertInterfaceNameToLuidA = ConvertInterfaceNameToLuidA(
    InterfaceName : UInt8*,   # LPCSTR
    InterfaceLuid : NET_LUID_LH*   # NET_LUID_LH* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ConvertInterfaceNameToLuidANative = Uint32 Function(Pointer<Utf8>, Pointer<Void>);
typedef ConvertInterfaceNameToLuidADart = int Function(Pointer<Utf8>, Pointer<Void>);
final ConvertInterfaceNameToLuidA = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<ConvertInterfaceNameToLuidANative, ConvertInterfaceNameToLuidADart>('ConvertInterfaceNameToLuidA');
// InterfaceName : LPCSTR -> Pointer<Utf8>
// InterfaceLuid : NET_LUID_LH* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ConvertInterfaceNameToLuidA(
  InterfaceName: PAnsiChar;   // LPCSTR
  InterfaceLuid: Pointer   // NET_LUID_LH* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'ConvertInterfaceNameToLuidA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ConvertInterfaceNameToLuidA"
  c_ConvertInterfaceNameToLuidA :: CString -> Ptr () -> IO Word32
-- InterfaceName : LPCSTR -> CString
-- InterfaceLuid : NET_LUID_LH* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let convertinterfacenametoluida =
  foreign "ConvertInterfaceNameToLuidA"
    (string @-> (ptr void) @-> returning uint32_t)
(* InterfaceName : LPCSTR -> string *)
(* InterfaceLuid : NET_LUID_LH* 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 ("ConvertInterfaceNameToLuidA" convert-interface-name-to-luid-a :convention :stdcall) :uint32
  (interface-name :string)   ; LPCSTR
  (interface-luid :pointer))   ; NET_LUID_LH* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ConvertInterfaceNameToLuidA = Win32::API::More->new('IPHLPAPI',
    'DWORD ConvertInterfaceNameToLuidA(LPCSTR InterfaceName, LPVOID InterfaceLuid)');
# my $ret = $ConvertInterfaceNameToLuidA->Call($InterfaceName, $InterfaceLuid);
# InterfaceName : LPCSTR -> LPCSTR
# InterfaceLuid : NET_LUID_LH* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型