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

ConvertInterfaceLuidToAlias

関数
インターフェイスLUIDをエイリアス(別名)に変換する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR ConvertInterfaceLuidToAlias(
    const NET_LUID_LH* InterfaceLuid,
    LPWSTR InterfaceAlias,
    UINT_PTR Length
);

パラメーター

名前型方向説明
InterfaceLuidNET_LUID_LH*inネットワークインターフェースの NET_LUID へのポインターです。
InterfaceAliasLPWSTRout関数が正常に終了したときに、ネットワークインターフェースのエイリアス名を格納する NULL 終端の Unicode 文字列を保持するバッファーへのポインターです。
LengthUINT_PTRinInterfaceAlias パラメーターが指すバッファーの長さ (文字数) です。この値は、ネットワークインターフェースのエイリアス名と終端の NULL 文字を格納できる十分な大きさである必要があります。必要となる最大の長さは NDIS_IF_MAX_STRING_SIZE + 1 です。

戻り値の型: WIN32_ERROR

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

ネットワークインターフェースのエイリアス名の最大長 NDIS_IF_MAX_STRING_SIZE (終端の NULL を含まない) は、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
#include <windows.h>

WIN32_ERROR ConvertInterfaceLuidToAlias(
    const NET_LUID_LH* InterfaceLuid,
    LPWSTR InterfaceAlias,
    UINT_PTR Length
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint ConvertInterfaceLuidToAlias(
    IntPtr InterfaceLuid,   // NET_LUID_LH*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder InterfaceAlias,   // LPWSTR out
    UIntPtr Length   // UINT_PTR
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function ConvertInterfaceLuidToAlias(
    InterfaceLuid As IntPtr,   ' NET_LUID_LH*
    <MarshalAs(UnmanagedType.LPWStr)> InterfaceAlias As System.Text.StringBuilder,   ' LPWSTR out
    Length As UIntPtr   ' UINT_PTR
) As UInteger
End Function
' InterfaceLuid : NET_LUID_LH*
' InterfaceAlias : LPWSTR out
' Length : UINT_PTR
Declare PtrSafe Function ConvertInterfaceLuidToAlias Lib "iphlpapi" ( _
    ByVal InterfaceLuid As LongPtr, _
    ByVal InterfaceAlias As LongPtr, _
    ByVal Length As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ConvertInterfaceLuidToAlias = ctypes.windll.iphlpapi.ConvertInterfaceLuidToAlias
ConvertInterfaceLuidToAlias.restype = wintypes.DWORD
ConvertInterfaceLuidToAlias.argtypes = [
    ctypes.c_void_p,  # InterfaceLuid : NET_LUID_LH*
    wintypes.LPWSTR,  # InterfaceAlias : LPWSTR out
    ctypes.c_size_t,  # Length : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procConvertInterfaceLuidToAlias = iphlpapi.NewProc("ConvertInterfaceLuidToAlias")
)

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

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

typedef ConvertInterfaceLuidToAliasNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, UintPtr);
typedef ConvertInterfaceLuidToAliasDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final ConvertInterfaceLuidToAlias = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<ConvertInterfaceLuidToAliasNative, ConvertInterfaceLuidToAliasDart>('ConvertInterfaceLuidToAlias');
// InterfaceLuid : NET_LUID_LH* -> Pointer<Void>
// InterfaceAlias : LPWSTR out -> Pointer<Utf16>
// Length : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ConvertInterfaceLuidToAlias(
  InterfaceLuid: Pointer;   // NET_LUID_LH*
  InterfaceAlias: PWideChar;   // LPWSTR out
  Length: NativeUInt   // UINT_PTR
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'ConvertInterfaceLuidToAlias';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ConvertInterfaceLuidToAlias"
  c_ConvertInterfaceLuidToAlias :: Ptr () -> CWString -> CUIntPtr -> IO Word32
-- InterfaceLuid : NET_LUID_LH* -> Ptr ()
-- InterfaceAlias : LPWSTR out -> CWString
-- Length : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let convertinterfaceluidtoalias =
  foreign "ConvertInterfaceLuidToAlias"
    ((ptr void) @-> (ptr uint16_t) @-> size_t @-> returning uint32_t)
(* InterfaceLuid : NET_LUID_LH* -> (ptr void) *)
(* InterfaceAlias : LPWSTR out -> (ptr uint16_t) *)
(* Length : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("ConvertInterfaceLuidToAlias" convert-interface-luid-to-alias :convention :stdcall) :uint32
  (interface-luid :pointer)   ; NET_LUID_LH*
  (interface-alias :pointer)   ; LPWSTR out
  (length :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ConvertInterfaceLuidToAlias = Win32::API::More->new('IPHLPAPI',
    'DWORD ConvertInterfaceLuidToAlias(LPVOID InterfaceLuid, LPWSTR InterfaceAlias, WPARAM Length)');
# my $ret = $ConvertInterfaceLuidToAlias->Call($InterfaceLuid, $InterfaceAlias, $Length);
# InterfaceLuid : NET_LUID_LH* -> LPVOID
# InterfaceAlias : LPWSTR out -> LPWSTR
# Length : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型