Win32 API 日本語リファレンス
ホームDevices.DeviceAndDriverInstallation › CM_Get_Device_Interface_AliasW

CM_Get_Device_Interface_AliasW

関数
デバイスインターフェイスの別名インターフェイスを取得する。
DLLCFGMGR32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// CFGMGR32.dll  (Unicode / -W)
#include <windows.h>

CONFIGRET CM_Get_Device_Interface_AliasW(
    LPCWSTR pszDeviceInterface,
    GUID* AliasInterfaceGuid,
    LPWSTR pszAliasDeviceInterface,
    DWORD* pulLength,
    DWORD ulFlags
);

パラメーター

名前方向説明
pszDeviceInterfaceLPCWSTRin元となるデバイスインターフェイスパスを表すNULL終端のワイド文字列を指定する。
AliasInterfaceGuidGUID*in取得したい別名のインターフェイスクラスGUIDへのポインターを指定する。
pszAliasDeviceInterfaceLPWSTRout取得した別名インターフェイスパスを受け取るワイド文字列バッファーへのポインター。
pulLengthDWORD*inout入力時はバッファーサイズ、出力時は実際の長さ(文字数)を示すDWORDへのポインター。
ulFlagsDWORDin動作を制御するフラグ。通常は0を指定する。

戻り値の型: CONFIGRET

各言語での呼び出し定義

// CFGMGR32.dll  (Unicode / -W)
#include <windows.h>

CONFIGRET CM_Get_Device_Interface_AliasW(
    LPCWSTR pszDeviceInterface,
    GUID* AliasInterfaceGuid,
    LPWSTR pszAliasDeviceInterface,
    DWORD* pulLength,
    DWORD ulFlags
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint CM_Get_Device_Interface_AliasW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszDeviceInterface,   // LPCWSTR
    ref Guid AliasInterfaceGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszAliasDeviceInterface,   // LPWSTR out
    ref uint pulLength,   // DWORD* in/out
    uint ulFlags   // DWORD
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function CM_Get_Device_Interface_AliasW(
    <MarshalAs(UnmanagedType.LPWStr)> pszDeviceInterface As String,   ' LPCWSTR
    ByRef AliasInterfaceGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> pszAliasDeviceInterface As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pulLength As UInteger,   ' DWORD* in/out
    ulFlags As UInteger   ' DWORD
) As UInteger
End Function
' pszDeviceInterface : LPCWSTR
' AliasInterfaceGuid : GUID*
' pszAliasDeviceInterface : LPWSTR out
' pulLength : DWORD* in/out
' ulFlags : DWORD
Declare PtrSafe Function CM_Get_Device_Interface_AliasW Lib "cfgmgr32" ( _
    ByVal pszDeviceInterface As LongPtr, _
    ByVal AliasInterfaceGuid As LongPtr, _
    ByVal pszAliasDeviceInterface As LongPtr, _
    ByRef pulLength As Long, _
    ByVal ulFlags As Long) 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

CM_Get_Device_Interface_AliasW = ctypes.windll.cfgmgr32.CM_Get_Device_Interface_AliasW
CM_Get_Device_Interface_AliasW.restype = wintypes.DWORD
CM_Get_Device_Interface_AliasW.argtypes = [
    wintypes.LPCWSTR,  # pszDeviceInterface : LPCWSTR
    ctypes.c_void_p,  # AliasInterfaceGuid : GUID*
    wintypes.LPWSTR,  # pszAliasDeviceInterface : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pulLength : DWORD* in/out
    wintypes.DWORD,  # ulFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CFGMGR32.dll')
CM_Get_Device_Interface_AliasW = Fiddle::Function.new(
  lib['CM_Get_Device_Interface_AliasW'],
  [
    Fiddle::TYPE_VOIDP,  # pszDeviceInterface : LPCWSTR
    Fiddle::TYPE_VOIDP,  # AliasInterfaceGuid : GUID*
    Fiddle::TYPE_VOIDP,  # pszAliasDeviceInterface : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pulLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # ulFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "cfgmgr32")]
extern "system" {
    fn CM_Get_Device_Interface_AliasW(
        pszDeviceInterface: *const u16,  // LPCWSTR
        AliasInterfaceGuid: *mut GUID,  // GUID*
        pszAliasDeviceInterface: *mut u16,  // LPWSTR out
        pulLength: *mut u32,  // DWORD* in/out
        ulFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CFGMGR32.dll", CharSet = CharSet.Unicode)]
public static extern uint CM_Get_Device_Interface_AliasW([MarshalAs(UnmanagedType.LPWStr)] string pszDeviceInterface, ref Guid AliasInterfaceGuid, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszAliasDeviceInterface, ref uint pulLength, uint ulFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Get_Device_Interface_AliasW' -Namespace Win32 -PassThru
# $api::CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
#uselib "CFGMGR32.dll"
#func global CM_Get_Device_Interface_AliasW "CM_Get_Device_Interface_AliasW" wptr, wptr, wptr, wptr, wptr
; CM_Get_Device_Interface_AliasW pszDeviceInterface, varptr(AliasInterfaceGuid), varptr(pszAliasDeviceInterface), varptr(pulLength), ulFlags   ; 戻り値は stat
; pszDeviceInterface : LPCWSTR -> "wptr"
; AliasInterfaceGuid : GUID* -> "wptr"
; pszAliasDeviceInterface : LPWSTR out -> "wptr"
; pulLength : DWORD* in/out -> "wptr"
; ulFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_Interface_AliasW "CM_Get_Device_Interface_AliasW" wstr, var, var, var, int
; res = CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
; pszDeviceInterface : LPCWSTR -> "wstr"
; AliasInterfaceGuid : GUID* -> "var"
; pszAliasDeviceInterface : LPWSTR out -> "var"
; pulLength : DWORD* in/out -> "var"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; CONFIGRET CM_Get_Device_Interface_AliasW(LPCWSTR pszDeviceInterface, GUID* AliasInterfaceGuid, LPWSTR pszAliasDeviceInterface, DWORD* pulLength, DWORD ulFlags)
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_Interface_AliasW "CM_Get_Device_Interface_AliasW" wstr, var, var, var, int
; res = CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
; pszDeviceInterface : LPCWSTR -> "wstr"
; AliasInterfaceGuid : GUID* -> "var"
; pszAliasDeviceInterface : LPWSTR out -> "var"
; pulLength : DWORD* in/out -> "var"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cfgmgr32 = windows.NewLazySystemDLL("CFGMGR32.dll")
	procCM_Get_Device_Interface_AliasW = cfgmgr32.NewProc("CM_Get_Device_Interface_AliasW")
)

// pszDeviceInterface (LPCWSTR), AliasInterfaceGuid (GUID*), pszAliasDeviceInterface (LPWSTR out), pulLength (DWORD* in/out), ulFlags (DWORD)
r1, _, err := procCM_Get_Device_Interface_AliasW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszDeviceInterface))),
	uintptr(AliasInterfaceGuid),
	uintptr(pszAliasDeviceInterface),
	uintptr(pulLength),
	uintptr(ulFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // CONFIGRET
function CM_Get_Device_Interface_AliasW(
  pszDeviceInterface: PWideChar;   // LPCWSTR
  AliasInterfaceGuid: PGUID;   // GUID*
  pszAliasDeviceInterface: PWideChar;   // LPWSTR out
  pulLength: Pointer;   // DWORD* in/out
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_Interface_AliasW';
result := DllCall("CFGMGR32\CM_Get_Device_Interface_AliasW"
    , "WStr", pszDeviceInterface   ; LPCWSTR
    , "Ptr", AliasInterfaceGuid   ; GUID*
    , "Ptr", pszAliasDeviceInterface   ; LPWSTR out
    , "Ptr", pulLength   ; DWORD* in/out
    , "UInt", ulFlags   ; DWORD
    , "UInt")   ; return: CONFIGRET
●CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags) = DLL("CFGMGR32.dll", "dword CM_Get_Device_Interface_AliasW(char*, void*, char*, void*, dword)")
# 呼び出し: CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
# pszDeviceInterface : LPCWSTR -> "char*"
# AliasInterfaceGuid : GUID* -> "void*"
# pszAliasDeviceInterface : LPWSTR out -> "char*"
# pulLength : DWORD* in/out -> "void*"
# ulFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "cfgmgr32" fn CM_Get_Device_Interface_AliasW(
    pszDeviceInterface: [*c]const u16, // LPCWSTR
    AliasInterfaceGuid: [*c]GUID, // GUID*
    pszAliasDeviceInterface: [*c]u16, // LPWSTR out
    pulLength: [*c]u32, // DWORD* in/out
    ulFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CM_Get_Device_Interface_AliasW(
    pszDeviceInterface: WideCString,  # LPCWSTR
    AliasInterfaceGuid: ptr GUID,  # GUID*
    pszAliasDeviceInterface: ptr uint16,  # LPWSTR out
    pulLength: ptr uint32,  # DWORD* in/out
    ulFlags: uint32  # DWORD
): uint32 {.importc: "CM_Get_Device_Interface_AliasW", stdcall, dynlib: "CFGMGR32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "cfgmgr32");
extern(Windows)
uint CM_Get_Device_Interface_AliasW(
    const(wchar)* pszDeviceInterface,   // LPCWSTR
    GUID* AliasInterfaceGuid,   // GUID*
    wchar* pszAliasDeviceInterface,   // LPWSTR out
    uint* pulLength,   // DWORD* in/out
    uint ulFlags   // DWORD
);
ccall((:CM_Get_Device_Interface_AliasW, "CFGMGR32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{GUID}, Ptr{UInt16}, Ptr{UInt32}, UInt32),
      pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
# pszDeviceInterface : LPCWSTR -> Cwstring
# AliasInterfaceGuid : GUID* -> Ptr{GUID}
# pszAliasDeviceInterface : LPWSTR out -> Ptr{UInt16}
# pulLength : DWORD* in/out -> Ptr{UInt32}
# ulFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t CM_Get_Device_Interface_AliasW(
    const uint16_t* pszDeviceInterface,
    void* AliasInterfaceGuid,
    uint16_t* pszAliasDeviceInterface,
    uint32_t* pulLength,
    uint32_t ulFlags);
]]
local cfgmgr32 = ffi.load("cfgmgr32")
-- cfgmgr32.CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
-- pszDeviceInterface : LPCWSTR
-- AliasInterfaceGuid : GUID*
-- pszAliasDeviceInterface : LPWSTR out
-- pulLength : DWORD* in/out
-- ulFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('CFGMGR32.dll');
const CM_Get_Device_Interface_AliasW = lib.func('__stdcall', 'CM_Get_Device_Interface_AliasW', 'uint32_t', ['str16', 'void *', 'uint16_t *', 'uint32_t *', 'uint32_t']);
// CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
// pszDeviceInterface : LPCWSTR -> 'str16'
// AliasInterfaceGuid : GUID* -> 'void *'
// pszAliasDeviceInterface : LPWSTR out -> 'uint16_t *'
// pulLength : DWORD* in/out -> 'uint32_t *'
// ulFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CFGMGR32.dll", {
  CM_Get_Device_Interface_AliasW: { parameters: ["buffer", "pointer", "buffer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
// pszDeviceInterface : LPCWSTR -> "buffer"
// AliasInterfaceGuid : GUID* -> "pointer"
// pszAliasDeviceInterface : LPWSTR out -> "buffer"
// pulLength : DWORD* in/out -> "pointer"
// ulFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t CM_Get_Device_Interface_AliasW(
    const uint16_t* pszDeviceInterface,
    void* AliasInterfaceGuid,
    uint16_t* pszAliasDeviceInterface,
    uint32_t* pulLength,
    uint32_t ulFlags);
C, "CFGMGR32.dll");
// $ffi->CM_Get_Device_Interface_AliasW(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags);
// pszDeviceInterface : LPCWSTR
// AliasInterfaceGuid : GUID*
// pszAliasDeviceInterface : LPWSTR out
// pulLength : DWORD* in/out
// ulFlags : DWORD
// 構造体/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 Cfgmgr32 extends StdCallLibrary {
    Cfgmgr32 INSTANCE = Native.load("cfgmgr32", Cfgmgr32.class, W32APIOptions.UNICODE_OPTIONS);
    int CM_Get_Device_Interface_AliasW(
        WString pszDeviceInterface,   // LPCWSTR
        Pointer AliasInterfaceGuid,   // GUID*
        char[] pszAliasDeviceInterface,   // LPWSTR out
        IntByReference pulLength,   // DWORD* in/out
        int ulFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("cfgmgr32")]
lib LibCFGMGR32
  fun CM_Get_Device_Interface_AliasW = CM_Get_Device_Interface_AliasW(
    pszDeviceInterface : UInt16*,   # LPCWSTR
    AliasInterfaceGuid : GUID*,   # GUID*
    pszAliasDeviceInterface : UInt16*,   # LPWSTR out
    pulLength : UInt32*,   # DWORD* in/out
    ulFlags : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CM_Get_Device_Interface_AliasWNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, Pointer<Uint32>, Uint32);
typedef CM_Get_Device_Interface_AliasWDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Utf16>, Pointer<Uint32>, int);
final CM_Get_Device_Interface_AliasW = DynamicLibrary.open('CFGMGR32.dll')
    .lookupFunction<CM_Get_Device_Interface_AliasWNative, CM_Get_Device_Interface_AliasWDart>('CM_Get_Device_Interface_AliasW');
// pszDeviceInterface : LPCWSTR -> Pointer<Utf16>
// AliasInterfaceGuid : GUID* -> Pointer<Void>
// pszAliasDeviceInterface : LPWSTR out -> Pointer<Utf16>
// pulLength : DWORD* in/out -> Pointer<Uint32>
// ulFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CM_Get_Device_Interface_AliasW(
  pszDeviceInterface: PWideChar;   // LPCWSTR
  AliasInterfaceGuid: PGUID;   // GUID*
  pszAliasDeviceInterface: PWideChar;   // LPWSTR out
  pulLength: Pointer;   // DWORD* in/out
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_Interface_AliasW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CM_Get_Device_Interface_AliasW"
  c_CM_Get_Device_Interface_AliasW :: CWString -> Ptr () -> CWString -> Ptr Word32 -> Word32 -> IO Word32
-- pszDeviceInterface : LPCWSTR -> CWString
-- AliasInterfaceGuid : GUID* -> Ptr ()
-- pszAliasDeviceInterface : LPWSTR out -> CWString
-- pulLength : DWORD* in/out -> Ptr Word32
-- ulFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cm_get_device_interface_aliasw =
  foreign "CM_Get_Device_Interface_AliasW"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* pszDeviceInterface : LPCWSTR -> (ptr uint16_t) *)
(* AliasInterfaceGuid : GUID* -> (ptr void) *)
(* pszAliasDeviceInterface : LPWSTR out -> (ptr uint16_t) *)
(* pulLength : DWORD* in/out -> (ptr uint32_t) *)
(* ulFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cfgmgr32 (t "CFGMGR32.dll"))
(cffi:use-foreign-library cfgmgr32)

(cffi:defcfun ("CM_Get_Device_Interface_AliasW" cm-get-device-interface-alias-w :convention :stdcall) :uint32
  (psz-device-interface (:string :encoding :utf-16le))   ; LPCWSTR
  (alias-interface-guid :pointer)   ; GUID*
  (psz-alias-device-interface :pointer)   ; LPWSTR out
  (pul-length :pointer)   ; DWORD* in/out
  (ul-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CM_Get_Device_Interface_AliasW = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Get_Device_Interface_AliasW(LPCWSTR pszDeviceInterface, LPVOID AliasInterfaceGuid, LPWSTR pszAliasDeviceInterface, LPVOID pulLength, DWORD ulFlags)');
# my $ret = $CM_Get_Device_Interface_AliasW->Call($pszDeviceInterface, $AliasInterfaceGuid, $pszAliasDeviceInterface, $pulLength, $ulFlags);
# pszDeviceInterface : LPCWSTR -> LPCWSTR
# AliasInterfaceGuid : GUID* -> LPVOID
# pszAliasDeviceInterface : LPWSTR out -> LPWSTR
# pulLength : DWORD* in/out -> LPVOID
# ulFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型