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

CM_Get_Device_ID_ListW

関数
条件に一致するデバイスIDの一覧を取得する。
DLLCFGMGR32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

CONFIGRET CM_Get_Device_ID_ListW(
    LPCWSTR pszFilter,   // optional
    LPWSTR Buffer,
    DWORD BufferLen,
    DWORD ulFlags
);

パラメーター

名前方向説明
pszFilterLPCWSTRinoptional列挙対象を絞り込むフィルター文字列(エニュメレータ名等)を表すNULL終端のワイド文字列を指定する。NULL可。
BufferLPWSTRoutデバイスIDの一覧(複数文字列)を受け取るワイド文字列バッファーへのポインター。
BufferLenDWORDinBufferのサイズを文字数で指定する。
ulFlagsDWORDin列挙条件を制御するフラグ(CM_GETIDLIST_FILTER_PRESENT等)を指定する。

戻り値の型: CONFIGRET

各言語での呼び出し定義

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

CONFIGRET CM_Get_Device_ID_ListW(
    LPCWSTR pszFilter,   // optional
    LPWSTR Buffer,
    DWORD BufferLen,
    DWORD ulFlags
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint CM_Get_Device_ID_ListW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszFilter,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer,   // LPWSTR out
    uint BufferLen,   // DWORD
    uint ulFlags   // DWORD
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function CM_Get_Device_ID_ListW(
    <MarshalAs(UnmanagedType.LPWStr)> pszFilter As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> Buffer As System.Text.StringBuilder,   ' LPWSTR out
    BufferLen As UInteger,   ' DWORD
    ulFlags As UInteger   ' DWORD
) As UInteger
End Function
' pszFilter : LPCWSTR optional
' Buffer : LPWSTR out
' BufferLen : DWORD
' ulFlags : DWORD
Declare PtrSafe Function CM_Get_Device_ID_ListW Lib "cfgmgr32" ( _
    ByVal pszFilter As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal BufferLen 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_ID_ListW = ctypes.windll.cfgmgr32.CM_Get_Device_ID_ListW
CM_Get_Device_ID_ListW.restype = wintypes.DWORD
CM_Get_Device_ID_ListW.argtypes = [
    wintypes.LPCWSTR,  # pszFilter : LPCWSTR optional
    wintypes.LPWSTR,  # Buffer : LPWSTR out
    wintypes.DWORD,  # BufferLen : DWORD
    wintypes.DWORD,  # ulFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CFGMGR32.dll')
CM_Get_Device_ID_ListW = Fiddle::Function.new(
  lib['CM_Get_Device_ID_ListW'],
  [
    Fiddle::TYPE_VOIDP,  # pszFilter : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Buffer : LPWSTR out
    -Fiddle::TYPE_INT,  # BufferLen : DWORD
    -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_ID_ListW(
        pszFilter: *const u16,  // LPCWSTR optional
        Buffer: *mut u16,  // LPWSTR out
        BufferLen: u32,  // DWORD
        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_ID_ListW([MarshalAs(UnmanagedType.LPWStr)] string pszFilter, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer, uint BufferLen, uint ulFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Get_Device_ID_ListW' -Namespace Win32 -PassThru
# $api::CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
#uselib "CFGMGR32.dll"
#func global CM_Get_Device_ID_ListW "CM_Get_Device_ID_ListW" wptr, wptr, wptr, wptr
; CM_Get_Device_ID_ListW pszFilter, varptr(Buffer), BufferLen, ulFlags   ; 戻り値は stat
; pszFilter : LPCWSTR optional -> "wptr"
; Buffer : LPWSTR out -> "wptr"
; BufferLen : DWORD -> "wptr"
; ulFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_ID_ListW "CM_Get_Device_ID_ListW" wstr, var, int, int
; res = CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
; pszFilter : LPCWSTR optional -> "wstr"
; Buffer : LPWSTR out -> "var"
; BufferLen : DWORD -> "int"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; CONFIGRET CM_Get_Device_ID_ListW(LPCWSTR pszFilter, LPWSTR Buffer, DWORD BufferLen, DWORD ulFlags)
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_ID_ListW "CM_Get_Device_ID_ListW" wstr, var, int, int
; res = CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
; pszFilter : LPCWSTR optional -> "wstr"
; Buffer : LPWSTR out -> "var"
; BufferLen : DWORD -> "int"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cfgmgr32 = windows.NewLazySystemDLL("CFGMGR32.dll")
	procCM_Get_Device_ID_ListW = cfgmgr32.NewProc("CM_Get_Device_ID_ListW")
)

// pszFilter (LPCWSTR optional), Buffer (LPWSTR out), BufferLen (DWORD), ulFlags (DWORD)
r1, _, err := procCM_Get_Device_ID_ListW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszFilter))),
	uintptr(Buffer),
	uintptr(BufferLen),
	uintptr(ulFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // CONFIGRET
function CM_Get_Device_ID_ListW(
  pszFilter: PWideChar;   // LPCWSTR optional
  Buffer: PWideChar;   // LPWSTR out
  BufferLen: DWORD;   // DWORD
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_ID_ListW';
result := DllCall("CFGMGR32\CM_Get_Device_ID_ListW"
    , "WStr", pszFilter   ; LPCWSTR optional
    , "Ptr", Buffer   ; LPWSTR out
    , "UInt", BufferLen   ; DWORD
    , "UInt", ulFlags   ; DWORD
    , "UInt")   ; return: CONFIGRET
●CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags) = DLL("CFGMGR32.dll", "dword CM_Get_Device_ID_ListW(char*, char*, dword, dword)")
# 呼び出し: CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
# pszFilter : LPCWSTR optional -> "char*"
# Buffer : LPWSTR out -> "char*"
# BufferLen : DWORD -> "dword"
# 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_ID_ListW(
    pszFilter: [*c]const u16, // LPCWSTR optional
    Buffer: [*c]u16, // LPWSTR out
    BufferLen: u32, // DWORD
    ulFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CM_Get_Device_ID_ListW(
    pszFilter: WideCString,  # LPCWSTR optional
    Buffer: ptr uint16,  # LPWSTR out
    BufferLen: uint32,  # DWORD
    ulFlags: uint32  # DWORD
): uint32 {.importc: "CM_Get_Device_ID_ListW", stdcall, dynlib: "CFGMGR32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "cfgmgr32");
extern(Windows)
uint CM_Get_Device_ID_ListW(
    const(wchar)* pszFilter,   // LPCWSTR optional
    wchar* Buffer,   // LPWSTR out
    uint BufferLen,   // DWORD
    uint ulFlags   // DWORD
);
ccall((:CM_Get_Device_ID_ListW, "CFGMGR32.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt16}, UInt32, UInt32),
      pszFilter, Buffer, BufferLen, ulFlags)
# pszFilter : LPCWSTR optional -> Cwstring
# Buffer : LPWSTR out -> Ptr{UInt16}
# BufferLen : DWORD -> 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_ID_ListW(
    const uint16_t* pszFilter,
    uint16_t* Buffer,
    uint32_t BufferLen,
    uint32_t ulFlags);
]]
local cfgmgr32 = ffi.load("cfgmgr32")
-- cfgmgr32.CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
-- pszFilter : LPCWSTR optional
-- Buffer : LPWSTR out
-- BufferLen : DWORD
-- 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_ID_ListW = lib.func('__stdcall', 'CM_Get_Device_ID_ListW', 'uint32_t', ['str16', 'uint16_t *', 'uint32_t', 'uint32_t']);
// CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
// pszFilter : LPCWSTR optional -> 'str16'
// Buffer : LPWSTR out -> 'uint16_t *'
// BufferLen : DWORD -> 'uint32_t'
// ulFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("CFGMGR32.dll", {
  CM_Get_Device_ID_ListW: { parameters: ["buffer", "buffer", "u32", "u32"], result: "u32" },
});
// lib.symbols.CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags)
// pszFilter : LPCWSTR optional -> "buffer"
// Buffer : LPWSTR out -> "buffer"
// BufferLen : DWORD -> "u32"
// 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_ID_ListW(
    const uint16_t* pszFilter,
    uint16_t* Buffer,
    uint32_t BufferLen,
    uint32_t ulFlags);
C, "CFGMGR32.dll");
// $ffi->CM_Get_Device_ID_ListW(pszFilter, Buffer, BufferLen, ulFlags);
// pszFilter : LPCWSTR optional
// Buffer : LPWSTR out
// BufferLen : DWORD
// 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_ID_ListW(
        WString pszFilter,   // LPCWSTR optional
        char[] Buffer,   // LPWSTR out
        int BufferLen,   // DWORD
        int ulFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("cfgmgr32")]
lib LibCFGMGR32
  fun CM_Get_Device_ID_ListW = CM_Get_Device_ID_ListW(
    pszFilter : UInt16*,   # LPCWSTR optional
    Buffer : UInt16*,   # LPWSTR out
    BufferLen : UInt32,   # DWORD
    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_ID_ListWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32);
typedef CM_Get_Device_ID_ListWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int);
final CM_Get_Device_ID_ListW = DynamicLibrary.open('CFGMGR32.dll')
    .lookupFunction<CM_Get_Device_ID_ListWNative, CM_Get_Device_ID_ListWDart>('CM_Get_Device_ID_ListW');
// pszFilter : LPCWSTR optional -> Pointer<Utf16>
// Buffer : LPWSTR out -> Pointer<Utf16>
// BufferLen : DWORD -> Uint32
// ulFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CM_Get_Device_ID_ListW(
  pszFilter: PWideChar;   // LPCWSTR optional
  Buffer: PWideChar;   // LPWSTR out
  BufferLen: DWORD;   // DWORD
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_ID_ListW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CM_Get_Device_ID_ListW"
  c_CM_Get_Device_ID_ListW :: CWString -> CWString -> Word32 -> Word32 -> IO Word32
-- pszFilter : LPCWSTR optional -> CWString
-- Buffer : LPWSTR out -> CWString
-- BufferLen : DWORD -> Word32
-- ulFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cm_get_device_id_listw =
  foreign "CM_Get_Device_ID_ListW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* pszFilter : LPCWSTR optional -> (ptr uint16_t) *)
(* Buffer : LPWSTR out -> (ptr uint16_t) *)
(* BufferLen : DWORD -> 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_ID_ListW" cm-get-device-id-list-w :convention :stdcall) :uint32
  (psz-filter (:string :encoding :utf-16le))   ; LPCWSTR optional
  (buffer :pointer)   ; LPWSTR out
  (buffer-len :uint32)   ; DWORD
  (ul-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CM_Get_Device_ID_ListW = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Get_Device_ID_ListW(LPCWSTR pszFilter, LPWSTR Buffer, DWORD BufferLen, DWORD ulFlags)');
# my $ret = $CM_Get_Device_ID_ListW->Call($pszFilter, $Buffer, $BufferLen, $ulFlags);
# pszFilter : LPCWSTR optional -> LPCWSTR
# Buffer : LPWSTR out -> LPWSTR
# BufferLen : DWORD -> DWORD
# ulFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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