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

CM_Get_Device_Interface_AliasA

関数
デバイスインターフェイスの別名インターフェイスを取得する。
DLLCFGMGR32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

CONFIGRET CM_Get_Device_Interface_AliasA(
    LPCSTR pszDeviceInterface,
    GUID* AliasInterfaceGuid,
    LPSTR pszAliasDeviceInterface,
    DWORD* pulLength,
    DWORD ulFlags
);

パラメーター

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

戻り値の型: CONFIGRET

各言語での呼び出し定義

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

CONFIGRET CM_Get_Device_Interface_AliasA(
    LPCSTR pszDeviceInterface,
    GUID* AliasInterfaceGuid,
    LPSTR pszAliasDeviceInterface,
    DWORD* pulLength,
    DWORD ulFlags
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CM_Get_Device_Interface_AliasA(
    [MarshalAs(UnmanagedType.LPStr)] string pszDeviceInterface,   // LPCSTR
    ref Guid AliasInterfaceGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszAliasDeviceInterface,   // LPSTR out
    ref uint pulLength,   // DWORD* in/out
    uint ulFlags   // DWORD
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CM_Get_Device_Interface_AliasA(
    <MarshalAs(UnmanagedType.LPStr)> pszDeviceInterface As String,   ' LPCSTR
    ByRef AliasInterfaceGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPStr)> pszAliasDeviceInterface As System.Text.StringBuilder,   ' LPSTR out
    ByRef pulLength As UInteger,   ' DWORD* in/out
    ulFlags As UInteger   ' DWORD
) As UInteger
End Function
' pszDeviceInterface : LPCSTR
' AliasInterfaceGuid : GUID*
' pszAliasDeviceInterface : LPSTR out
' pulLength : DWORD* in/out
' ulFlags : DWORD
Declare PtrSafe Function CM_Get_Device_Interface_AliasA Lib "cfgmgr32" ( _
    ByVal pszDeviceInterface As String, _
    ByVal AliasInterfaceGuid As LongPtr, _
    ByVal pszAliasDeviceInterface As String, _
    ByRef pulLength As Long, _
    ByVal ulFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CM_Get_Device_Interface_AliasA = ctypes.windll.cfgmgr32.CM_Get_Device_Interface_AliasA
CM_Get_Device_Interface_AliasA.restype = wintypes.DWORD
CM_Get_Device_Interface_AliasA.argtypes = [
    wintypes.LPCSTR,  # pszDeviceInterface : LPCSTR
    ctypes.c_void_p,  # AliasInterfaceGuid : GUID*
    wintypes.LPSTR,  # pszAliasDeviceInterface : LPSTR 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_AliasA = Fiddle::Function.new(
  lib['CM_Get_Device_Interface_AliasA'],
  [
    Fiddle::TYPE_VOIDP,  # pszDeviceInterface : LPCSTR
    Fiddle::TYPE_VOIDP,  # AliasInterfaceGuid : GUID*
    Fiddle::TYPE_VOIDP,  # pszAliasDeviceInterface : LPSTR out
    Fiddle::TYPE_VOIDP,  # pulLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # ulFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "cfgmgr32")]
extern "system" {
    fn CM_Get_Device_Interface_AliasA(
        pszDeviceInterface: *const u8,  // LPCSTR
        AliasInterfaceGuid: *mut GUID,  // GUID*
        pszAliasDeviceInterface: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint CM_Get_Device_Interface_AliasA([MarshalAs(UnmanagedType.LPStr)] string pszDeviceInterface, ref Guid AliasInterfaceGuid, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszAliasDeviceInterface, ref uint pulLength, uint ulFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Get_Device_Interface_AliasA' -Namespace Win32 -PassThru
# $api::CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
#uselib "CFGMGR32.dll"
#func global CM_Get_Device_Interface_AliasA "CM_Get_Device_Interface_AliasA" sptr, sptr, sptr, sptr, sptr
; CM_Get_Device_Interface_AliasA pszDeviceInterface, varptr(AliasInterfaceGuid), varptr(pszAliasDeviceInterface), varptr(pulLength), ulFlags   ; 戻り値は stat
; pszDeviceInterface : LPCSTR -> "sptr"
; AliasInterfaceGuid : GUID* -> "sptr"
; pszAliasDeviceInterface : LPSTR out -> "sptr"
; pulLength : DWORD* in/out -> "sptr"
; ulFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_Interface_AliasA "CM_Get_Device_Interface_AliasA" str, var, var, var, int
; res = CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
; pszDeviceInterface : LPCSTR -> "str"
; AliasInterfaceGuid : GUID* -> "var"
; pszAliasDeviceInterface : LPSTR out -> "var"
; pulLength : DWORD* in/out -> "var"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; CONFIGRET CM_Get_Device_Interface_AliasA(LPCSTR pszDeviceInterface, GUID* AliasInterfaceGuid, LPSTR pszAliasDeviceInterface, DWORD* pulLength, DWORD ulFlags)
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_Interface_AliasA "CM_Get_Device_Interface_AliasA" str, var, var, var, int
; res = CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
; pszDeviceInterface : LPCSTR -> "str"
; AliasInterfaceGuid : GUID* -> "var"
; pszAliasDeviceInterface : LPSTR 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_AliasA = cfgmgr32.NewProc("CM_Get_Device_Interface_AliasA")
)

// pszDeviceInterface (LPCSTR), AliasInterfaceGuid (GUID*), pszAliasDeviceInterface (LPSTR out), pulLength (DWORD* in/out), ulFlags (DWORD)
r1, _, err := procCM_Get_Device_Interface_AliasA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(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_AliasA(
  pszDeviceInterface: PAnsiChar;   // LPCSTR
  AliasInterfaceGuid: PGUID;   // GUID*
  pszAliasDeviceInterface: PAnsiChar;   // LPSTR out
  pulLength: Pointer;   // DWORD* in/out
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_Interface_AliasA';
result := DllCall("CFGMGR32\CM_Get_Device_Interface_AliasA"
    , "AStr", pszDeviceInterface   ; LPCSTR
    , "Ptr", AliasInterfaceGuid   ; GUID*
    , "Ptr", pszAliasDeviceInterface   ; LPSTR out
    , "Ptr", pulLength   ; DWORD* in/out
    , "UInt", ulFlags   ; DWORD
    , "UInt")   ; return: CONFIGRET
●CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags) = DLL("CFGMGR32.dll", "dword CM_Get_Device_Interface_AliasA(char*, void*, char*, void*, dword)")
# 呼び出し: CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
# pszDeviceInterface : LPCSTR -> "char*"
# AliasInterfaceGuid : GUID* -> "void*"
# pszAliasDeviceInterface : LPSTR out -> "char*"
# pulLength : DWORD* in/out -> "void*"
# ulFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "cfgmgr32" fn CM_Get_Device_Interface_AliasA(
    pszDeviceInterface: [*c]const u8, // LPCSTR
    AliasInterfaceGuid: [*c]GUID, // GUID*
    pszAliasDeviceInterface: [*c]u8, // LPSTR out
    pulLength: [*c]u32, // DWORD* in/out
    ulFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc CM_Get_Device_Interface_AliasA(
    pszDeviceInterface: cstring,  # LPCSTR
    AliasInterfaceGuid: ptr GUID,  # GUID*
    pszAliasDeviceInterface: ptr char,  # LPSTR out
    pulLength: ptr uint32,  # DWORD* in/out
    ulFlags: uint32  # DWORD
): uint32 {.importc: "CM_Get_Device_Interface_AliasA", stdcall, dynlib: "CFGMGR32.dll".}
pragma(lib, "cfgmgr32");
extern(Windows)
uint CM_Get_Device_Interface_AliasA(
    const(char)* pszDeviceInterface,   // LPCSTR
    GUID* AliasInterfaceGuid,   // GUID*
    char* pszAliasDeviceInterface,   // LPSTR out
    uint* pulLength,   // DWORD* in/out
    uint ulFlags   // DWORD
);
ccall((:CM_Get_Device_Interface_AliasA, "CFGMGR32.dll"), stdcall, UInt32,
      (Cstring, Ptr{GUID}, Ptr{UInt8}, Ptr{UInt32}, UInt32),
      pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
# pszDeviceInterface : LPCSTR -> Cstring
# AliasInterfaceGuid : GUID* -> Ptr{GUID}
# pszAliasDeviceInterface : LPSTR out -> Ptr{UInt8}
# pulLength : DWORD* in/out -> Ptr{UInt32}
# ulFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t CM_Get_Device_Interface_AliasA(
    const char* pszDeviceInterface,
    void* AliasInterfaceGuid,
    char* pszAliasDeviceInterface,
    uint32_t* pulLength,
    uint32_t ulFlags);
]]
local cfgmgr32 = ffi.load("cfgmgr32")
-- cfgmgr32.CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
-- pszDeviceInterface : LPCSTR
-- AliasInterfaceGuid : GUID*
-- pszAliasDeviceInterface : LPSTR out
-- pulLength : DWORD* in/out
-- ulFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('CFGMGR32.dll');
const CM_Get_Device_Interface_AliasA = lib.func('__stdcall', 'CM_Get_Device_Interface_AliasA', 'uint32_t', ['str', 'void *', 'char *', 'uint32_t *', 'uint32_t']);
// CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
// pszDeviceInterface : LPCSTR -> 'str'
// AliasInterfaceGuid : GUID* -> 'void *'
// pszAliasDeviceInterface : LPSTR out -> 'char *'
// pulLength : DWORD* in/out -> 'uint32_t *'
// ulFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CFGMGR32.dll", {
  CM_Get_Device_Interface_AliasA: { parameters: ["buffer", "pointer", "buffer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags)
// pszDeviceInterface : LPCSTR -> "buffer"
// AliasInterfaceGuid : GUID* -> "pointer"
// pszAliasDeviceInterface : LPSTR out -> "buffer"
// pulLength : DWORD* in/out -> "pointer"
// ulFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t CM_Get_Device_Interface_AliasA(
    const char* pszDeviceInterface,
    void* AliasInterfaceGuid,
    char* pszAliasDeviceInterface,
    uint32_t* pulLength,
    uint32_t ulFlags);
C, "CFGMGR32.dll");
// $ffi->CM_Get_Device_Interface_AliasA(pszDeviceInterface, AliasInterfaceGuid, pszAliasDeviceInterface, pulLength, ulFlags);
// pszDeviceInterface : LPCSTR
// AliasInterfaceGuid : GUID*
// pszAliasDeviceInterface : LPSTR 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.ASCII_OPTIONS);
    int CM_Get_Device_Interface_AliasA(
        String pszDeviceInterface,   // LPCSTR
        Pointer AliasInterfaceGuid,   // GUID*
        byte[] pszAliasDeviceInterface,   // LPSTR out
        IntByReference pulLength,   // DWORD* in/out
        int ulFlags   // DWORD
    );
}
@[Link("cfgmgr32")]
lib LibCFGMGR32
  fun CM_Get_Device_Interface_AliasA = CM_Get_Device_Interface_AliasA(
    pszDeviceInterface : UInt8*,   # LPCSTR
    AliasInterfaceGuid : GUID*,   # GUID*
    pszAliasDeviceInterface : UInt8*,   # LPSTR 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_AliasANative = Uint32 Function(Pointer<Utf8>, Pointer<Void>, Pointer<Utf8>, Pointer<Uint32>, Uint32);
typedef CM_Get_Device_Interface_AliasADart = int Function(Pointer<Utf8>, Pointer<Void>, Pointer<Utf8>, Pointer<Uint32>, int);
final CM_Get_Device_Interface_AliasA = DynamicLibrary.open('CFGMGR32.dll')
    .lookupFunction<CM_Get_Device_Interface_AliasANative, CM_Get_Device_Interface_AliasADart>('CM_Get_Device_Interface_AliasA');
// pszDeviceInterface : LPCSTR -> Pointer<Utf8>
// AliasInterfaceGuid : GUID* -> Pointer<Void>
// pszAliasDeviceInterface : LPSTR out -> Pointer<Utf8>
// pulLength : DWORD* in/out -> Pointer<Uint32>
// ulFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CM_Get_Device_Interface_AliasA(
  pszDeviceInterface: PAnsiChar;   // LPCSTR
  AliasInterfaceGuid: PGUID;   // GUID*
  pszAliasDeviceInterface: PAnsiChar;   // LPSTR out
  pulLength: Pointer;   // DWORD* in/out
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_Interface_AliasA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CM_Get_Device_Interface_AliasA"
  c_CM_Get_Device_Interface_AliasA :: CString -> Ptr () -> CString -> Ptr Word32 -> Word32 -> IO Word32
-- pszDeviceInterface : LPCSTR -> CString
-- AliasInterfaceGuid : GUID* -> Ptr ()
-- pszAliasDeviceInterface : LPSTR out -> CString
-- 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_aliasa =
  foreign "CM_Get_Device_Interface_AliasA"
    (string @-> (ptr void) @-> string @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* pszDeviceInterface : LPCSTR -> string *)
(* AliasInterfaceGuid : GUID* -> (ptr void) *)
(* pszAliasDeviceInterface : LPSTR out -> string *)
(* 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_AliasA" cm-get-device-interface-alias-a :convention :stdcall) :uint32
  (psz-device-interface :string)   ; LPCSTR
  (alias-interface-guid :pointer)   ; GUID*
  (psz-alias-device-interface :pointer)   ; LPSTR 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_AliasA = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Get_Device_Interface_AliasA(LPCSTR pszDeviceInterface, LPVOID AliasInterfaceGuid, LPSTR pszAliasDeviceInterface, LPVOID pulLength, DWORD ulFlags)');
# my $ret = $CM_Get_Device_Interface_AliasA->Call($pszDeviceInterface, $AliasInterfaceGuid, $pszAliasDeviceInterface, $pulLength, $ulFlags);
# pszDeviceInterface : LPCSTR -> LPCSTR
# AliasInterfaceGuid : GUID* -> LPVOID
# pszAliasDeviceInterface : LPSTR out -> LPSTR
# pulLength : DWORD* in/out -> LPVOID
# ulFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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