ConvertInterfaceNameToLuidW
関数シグネチャ
// IPHLPAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR ConvertInterfaceNameToLuidW(
LPCWSTR InterfaceName,
NET_LUID_LH* InterfaceLuid
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| InterfaceName | LPCWSTR | in | ネットワークインターフェイス名を格納した NULL 終端の Unicode 文字列へのポインター。 |
| InterfaceLuid | NET_LUID_LH* | out | このインターフェイスの NET_LUID へのポインター。 |
戻り値の型: WIN32_ERROR
公式ドキュメント
Unicode のネットワークインターフェイス名を、そのインターフェイスのローカル一意識別子 (LUID) に変換します。
戻り値
成功した場合、 ConvertInterfaceNameToLuidW は NETIO_ERROR_SUCCESS を返します。0 以外の戻り値は失敗を示します。
| エラーコード | 意味 |
|---|---|
| インターフェイス名が無効でした。このエラーは、InterfaceName パラメーターに無効な名前が含まれていた場合、または InterfaceName パラメーターの長さがこのパラメーターで許可される最大文字列長を超えた場合に返されます。 | |
| いずれかのパラメーターが無効でした。このエラーは、InterfaceLuid パラメーターが NULL であった場合に返されます。 |
解説(Remarks)
ConvertInterfaceNameToLuidW 関数は Windows Vista 以降で利用できます。
ConvertInterfaceNameToLuidW 関数はプロトコルに依存せず、IPv6 と IPv4 の両プロトコルのネットワークインターフェイスで動作します。ConvertInterfaceNameToLuidW は Unicode のインターフェイス名を LUID に変換します。
ConvertInterfaceNameToLuidA は ANSI のインターフェイス名を 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 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// IPHLPAPI.dll (Unicode / -W)
#include <windows.h>
WIN32_ERROR ConvertInterfaceNameToLuidW(
LPCWSTR InterfaceName,
NET_LUID_LH* InterfaceLuid
);[DllImport("IPHLPAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ConvertInterfaceNameToLuidW(
[MarshalAs(UnmanagedType.LPWStr)] string InterfaceName, // LPCWSTR
IntPtr InterfaceLuid // NET_LUID_LH* out
);<DllImport("IPHLPAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ConvertInterfaceNameToLuidW(
<MarshalAs(UnmanagedType.LPWStr)> InterfaceName As String, ' LPCWSTR
InterfaceLuid As IntPtr ' NET_LUID_LH* out
) As UInteger
End Function' InterfaceName : LPCWSTR
' InterfaceLuid : NET_LUID_LH* out
Declare PtrSafe Function ConvertInterfaceNameToLuidW Lib "iphlpapi" ( _
ByVal InterfaceName As LongPtr, _
ByVal InterfaceLuid As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ConvertInterfaceNameToLuidW = ctypes.windll.iphlpapi.ConvertInterfaceNameToLuidW
ConvertInterfaceNameToLuidW.restype = wintypes.DWORD
ConvertInterfaceNameToLuidW.argtypes = [
wintypes.LPCWSTR, # InterfaceName : LPCWSTR
ctypes.c_void_p, # InterfaceLuid : NET_LUID_LH* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('IPHLPAPI.dll')
ConvertInterfaceNameToLuidW = Fiddle::Function.new(
lib['ConvertInterfaceNameToLuidW'],
[
Fiddle::TYPE_VOIDP, # InterfaceName : LPCWSTR
Fiddle::TYPE_VOIDP, # InterfaceLuid : NET_LUID_LH* out
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "iphlpapi")]
extern "system" {
fn ConvertInterfaceNameToLuidW(
InterfaceName: *const u16, // LPCWSTR
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.Unicode)]
public static extern uint ConvertInterfaceNameToLuidW([MarshalAs(UnmanagedType.LPWStr)] string InterfaceName, IntPtr InterfaceLuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_ConvertInterfaceNameToLuidW' -Namespace Win32 -PassThru
# $api::ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid)#uselib "IPHLPAPI.dll"
#func global ConvertInterfaceNameToLuidW "ConvertInterfaceNameToLuidW" wptr, wptr
; ConvertInterfaceNameToLuidW InterfaceName, varptr(InterfaceLuid) ; 戻り値は stat
; InterfaceName : LPCWSTR -> "wptr"
; InterfaceLuid : NET_LUID_LH* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "IPHLPAPI.dll" #cfunc global ConvertInterfaceNameToLuidW "ConvertInterfaceNameToLuidW" wstr, var ; res = ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid) ; InterfaceName : LPCWSTR -> "wstr" ; InterfaceLuid : NET_LUID_LH* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll" #cfunc global ConvertInterfaceNameToLuidW "ConvertInterfaceNameToLuidW" wstr, sptr ; res = ConvertInterfaceNameToLuidW(InterfaceName, varptr(InterfaceLuid)) ; InterfaceName : LPCWSTR -> "wstr" ; InterfaceLuid : NET_LUID_LH* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; WIN32_ERROR ConvertInterfaceNameToLuidW(LPCWSTR InterfaceName, NET_LUID_LH* InterfaceLuid) #uselib "IPHLPAPI.dll" #cfunc global ConvertInterfaceNameToLuidW "ConvertInterfaceNameToLuidW" wstr, var ; res = ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid) ; InterfaceName : LPCWSTR -> "wstr" ; InterfaceLuid : NET_LUID_LH* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; WIN32_ERROR ConvertInterfaceNameToLuidW(LPCWSTR InterfaceName, NET_LUID_LH* InterfaceLuid) #uselib "IPHLPAPI.dll" #cfunc global ConvertInterfaceNameToLuidW "ConvertInterfaceNameToLuidW" wstr, intptr ; res = ConvertInterfaceNameToLuidW(InterfaceName, varptr(InterfaceLuid)) ; InterfaceName : LPCWSTR -> "wstr" ; InterfaceLuid : NET_LUID_LH* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
procConvertInterfaceNameToLuidW = iphlpapi.NewProc("ConvertInterfaceNameToLuidW")
)
// InterfaceName (LPCWSTR), InterfaceLuid (NET_LUID_LH* out)
r1, _, err := procConvertInterfaceNameToLuidW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(InterfaceName))),
uintptr(InterfaceLuid),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // WIN32_ERRORfunction ConvertInterfaceNameToLuidW(
InterfaceName: PWideChar; // LPCWSTR
InterfaceLuid: Pointer // NET_LUID_LH* out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'ConvertInterfaceNameToLuidW';result := DllCall("IPHLPAPI\ConvertInterfaceNameToLuidW"
, "WStr", InterfaceName ; LPCWSTR
, "Ptr", InterfaceLuid ; NET_LUID_LH* out
, "UInt") ; return: WIN32_ERROR●ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid) = DLL("IPHLPAPI.dll", "dword ConvertInterfaceNameToLuidW(char*, void*)")
# 呼び出し: ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid)
# InterfaceName : LPCWSTR -> "char*"
# InterfaceLuid : NET_LUID_LH* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "iphlpapi" fn ConvertInterfaceNameToLuidW(
InterfaceName: [*c]const u16, // LPCWSTR
InterfaceLuid: [*c]NET_LUID_LH // NET_LUID_LH* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc ConvertInterfaceNameToLuidW(
InterfaceName: WideCString, # LPCWSTR
InterfaceLuid: ptr NET_LUID_LH # NET_LUID_LH* out
): uint32 {.importc: "ConvertInterfaceNameToLuidW", stdcall, dynlib: "IPHLPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "iphlpapi");
extern(Windows)
uint ConvertInterfaceNameToLuidW(
const(wchar)* InterfaceName, // LPCWSTR
NET_LUID_LH* InterfaceLuid // NET_LUID_LH* out
);ccall((:ConvertInterfaceNameToLuidW, "IPHLPAPI.dll"), stdcall, UInt32,
(Cwstring, Ptr{NET_LUID_LH}),
InterfaceName, InterfaceLuid)
# InterfaceName : LPCWSTR -> Cwstring
# InterfaceLuid : NET_LUID_LH* out -> Ptr{NET_LUID_LH}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t ConvertInterfaceNameToLuidW(
const uint16_t* InterfaceName,
void* InterfaceLuid);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid)
-- InterfaceName : LPCWSTR
-- InterfaceLuid : NET_LUID_LH* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const ConvertInterfaceNameToLuidW = lib.func('__stdcall', 'ConvertInterfaceNameToLuidW', 'uint32_t', ['str16', 'void *']);
// ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid)
// InterfaceName : LPCWSTR -> 'str16'
// InterfaceLuid : NET_LUID_LH* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("IPHLPAPI.dll", {
ConvertInterfaceNameToLuidW: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid)
// InterfaceName : LPCWSTR -> "buffer"
// InterfaceLuid : NET_LUID_LH* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t ConvertInterfaceNameToLuidW(
const uint16_t* InterfaceName,
void* InterfaceLuid);
C, "IPHLPAPI.dll");
// $ffi->ConvertInterfaceNameToLuidW(InterfaceName, InterfaceLuid);
// InterfaceName : LPCWSTR
// 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.UNICODE_OPTIONS);
int ConvertInterfaceNameToLuidW(
WString InterfaceName, // LPCWSTR
Pointer InterfaceLuid // NET_LUID_LH* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("iphlpapi")]
lib LibIPHLPAPI
fun ConvertInterfaceNameToLuidW = ConvertInterfaceNameToLuidW(
InterfaceName : UInt16*, # LPCWSTR
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 ConvertInterfaceNameToLuidWNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>);
typedef ConvertInterfaceNameToLuidWDart = int Function(Pointer<Utf16>, Pointer<Void>);
final ConvertInterfaceNameToLuidW = DynamicLibrary.open('IPHLPAPI.dll')
.lookupFunction<ConvertInterfaceNameToLuidWNative, ConvertInterfaceNameToLuidWDart>('ConvertInterfaceNameToLuidW');
// InterfaceName : LPCWSTR -> Pointer<Utf16>
// InterfaceLuid : NET_LUID_LH* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ConvertInterfaceNameToLuidW(
InterfaceName: PWideChar; // LPCWSTR
InterfaceLuid: Pointer // NET_LUID_LH* out
): DWORD; stdcall;
external 'IPHLPAPI.dll' name 'ConvertInterfaceNameToLuidW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ConvertInterfaceNameToLuidW"
c_ConvertInterfaceNameToLuidW :: CWString -> Ptr () -> IO Word32
-- InterfaceName : LPCWSTR -> CWString
-- InterfaceLuid : NET_LUID_LH* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let convertinterfacenametoluidw =
foreign "ConvertInterfaceNameToLuidW"
((ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* InterfaceName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("ConvertInterfaceNameToLuidW" convert-interface-name-to-luid-w :convention :stdcall) :uint32
(interface-name (:string :encoding :utf-16le)) ; LPCWSTR
(interface-luid :pointer)) ; NET_LUID_LH* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ConvertInterfaceNameToLuidW = Win32::API::More->new('IPHLPAPI',
'DWORD ConvertInterfaceNameToLuidW(LPCWSTR InterfaceName, LPVOID InterfaceLuid)');
# my $ret = $ConvertInterfaceNameToLuidW->Call($InterfaceName, $InterfaceLuid);
# InterfaceName : LPCWSTR -> LPCWSTR
# InterfaceLuid : NET_LUID_LH* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f ConvertInterfaceNameToLuidA (ANSI版) — インターフェイス名(ANSI)をLUIDに変換する。
- f ConvertInterfaceAliasToLuid — インターフェイスのエイリアス(別名)をLUIDに変換する。
- f ConvertInterfaceGuidToLuid — インターフェイスGUIDをLUIDに変換する。
- f ConvertInterfaceIndexToLuid — インターフェイス索引をLUIDに変換する。
- f ConvertInterfaceLuidToAlias — インターフェイスLUIDをエイリアス(別名)に変換する。
- f ConvertInterfaceLuidToGuid — インターフェイスLUIDをGUIDに変換する。
- f ConvertInterfaceLuidToIndex — インターフェイスLUIDをインターフェイス索引に変換する。
- f ConvertInterfaceLuidToNameW — インターフェイスLUIDを名前(Unicode)に変換する。
- f if_indextoname — インターフェイスインデックスを対応するインターフェイス名に変換する。
- f if_nametoindex — ネットワークインターフェイス名を対応するインターフェイスインデックスに変換する。