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

CM_Get_Device_ID_List_ExA

関数
指定マシンで条件に一致するデバイスID一覧を取得する。
DLLCFGMGR32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

CONFIGRET CM_Get_Device_ID_List_ExA(
    LPCSTR pszFilter,   // optional
    LPSTR Buffer,
    DWORD BufferLen,
    DWORD ulFlags,
    INT_PTR hMachine   // optional
);

パラメーター

名前型方向説明
pszFilterLPCSTRinoptional列挙対象を絞り込むフィルター文字列を表すNULL終端のANSI文字列を指定する。NULL可。
BufferLPSTRoutデバイスIDの一覧(複数文字列)を受け取るANSI文字列バッファーへのポインター。
BufferLenDWORDinBufferのサイズを文字数で指定する。
ulFlagsDWORDin列挙条件を制御するフラグ(CM_GETIDLIST_FILTER_PRESENT等)を指定する。
hMachineINT_PTRinoptional対象マシンへの接続ハンドルを指定する。ローカルの場合はNULL(0)を指定する。

戻り値の型: CONFIGRET

各言語での呼び出し定義

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

CONFIGRET CM_Get_Device_ID_List_ExA(
    LPCSTR pszFilter,   // optional
    LPSTR Buffer,
    DWORD BufferLen,
    DWORD ulFlags,
    INT_PTR hMachine   // optional
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CM_Get_Device_ID_List_ExA(
    [MarshalAs(UnmanagedType.LPStr)] string pszFilter,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Buffer,   // LPSTR out
    uint BufferLen,   // DWORD
    uint ulFlags,   // DWORD
    IntPtr hMachine   // INT_PTR optional
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CM_Get_Device_ID_List_ExA(
    <MarshalAs(UnmanagedType.LPStr)> pszFilter As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> Buffer As System.Text.StringBuilder,   ' LPSTR out
    BufferLen As UInteger,   ' DWORD
    ulFlags As UInteger,   ' DWORD
    hMachine As IntPtr   ' INT_PTR optional
) As UInteger
End Function
' pszFilter : LPCSTR optional
' Buffer : LPSTR out
' BufferLen : DWORD
' ulFlags : DWORD
' hMachine : INT_PTR optional
Declare PtrSafe Function CM_Get_Device_ID_List_ExA Lib "cfgmgr32" ( _
    ByVal pszFilter As String, _
    ByVal Buffer As String, _
    ByVal BufferLen As Long, _
    ByVal ulFlags As Long, _
    ByVal hMachine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CM_Get_Device_ID_List_ExA = ctypes.windll.cfgmgr32.CM_Get_Device_ID_List_ExA
CM_Get_Device_ID_List_ExA.restype = wintypes.DWORD
CM_Get_Device_ID_List_ExA.argtypes = [
    wintypes.LPCSTR,  # pszFilter : LPCSTR optional
    wintypes.LPSTR,  # Buffer : LPSTR out
    wintypes.DWORD,  # BufferLen : DWORD
    wintypes.DWORD,  # ulFlags : DWORD
    ctypes.c_ssize_t,  # hMachine : INT_PTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CFGMGR32.dll')
CM_Get_Device_ID_List_ExA = Fiddle::Function.new(
  lib['CM_Get_Device_ID_List_ExA'],
  [
    Fiddle::TYPE_VOIDP,  # pszFilter : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Buffer : LPSTR out
    -Fiddle::TYPE_INT,  # BufferLen : DWORD
    -Fiddle::TYPE_INT,  # ulFlags : DWORD
    Fiddle::TYPE_INTPTR_T,  # hMachine : INT_PTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "cfgmgr32")]
extern "system" {
    fn CM_Get_Device_ID_List_ExA(
        pszFilter: *const u8,  // LPCSTR optional
        Buffer: *mut u8,  // LPSTR out
        BufferLen: u32,  // DWORD
        ulFlags: u32,  // DWORD
        hMachine: isize  // INT_PTR optional
    ) -> 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_ID_List_ExA([MarshalAs(UnmanagedType.LPStr)] string pszFilter, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Buffer, uint BufferLen, uint ulFlags, IntPtr hMachine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Get_Device_ID_List_ExA' -Namespace Win32 -PassThru
# $api::CM_Get_Device_ID_List_ExA(pszFilter, Buffer, BufferLen, ulFlags, hMachine)
#uselib "CFGMGR32.dll"
#func global CM_Get_Device_ID_List_ExA "CM_Get_Device_ID_List_ExA" sptr, sptr, sptr, sptr, sptr
; CM_Get_Device_ID_List_ExA pszFilter, varptr(Buffer), BufferLen, ulFlags, hMachine   ; 戻り値は stat
; pszFilter : LPCSTR optional -> "sptr"
; Buffer : LPSTR out -> "sptr"
; BufferLen : DWORD -> "sptr"
; ulFlags : DWORD -> "sptr"
; hMachine : INT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_ID_List_ExA "CM_Get_Device_ID_List_ExA" str, var, int, int, sptr
; res = CM_Get_Device_ID_List_ExA(pszFilter, Buffer, BufferLen, ulFlags, hMachine)
; pszFilter : LPCSTR optional -> "str"
; Buffer : LPSTR out -> "var"
; BufferLen : DWORD -> "int"
; ulFlags : DWORD -> "int"
; hMachine : INT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; CONFIGRET CM_Get_Device_ID_List_ExA(LPCSTR pszFilter, LPSTR Buffer, DWORD BufferLen, DWORD ulFlags, INT_PTR hMachine)
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_Device_ID_List_ExA "CM_Get_Device_ID_List_ExA" str, var, int, int, intptr
; res = CM_Get_Device_ID_List_ExA(pszFilter, Buffer, BufferLen, ulFlags, hMachine)
; pszFilter : LPCSTR optional -> "str"
; Buffer : LPSTR out -> "var"
; BufferLen : DWORD -> "int"
; ulFlags : DWORD -> "int"
; hMachine : INT_PTR optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cfgmgr32 = windows.NewLazySystemDLL("CFGMGR32.dll")
	procCM_Get_Device_ID_List_ExA = cfgmgr32.NewProc("CM_Get_Device_ID_List_ExA")
)

// pszFilter (LPCSTR optional), Buffer (LPSTR out), BufferLen (DWORD), ulFlags (DWORD), hMachine (INT_PTR optional)
r1, _, err := procCM_Get_Device_ID_List_ExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszFilter))),
	uintptr(Buffer),
	uintptr(BufferLen),
	uintptr(ulFlags),
	uintptr(hMachine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // CONFIGRET
function CM_Get_Device_ID_List_ExA(
  pszFilter: PAnsiChar;   // LPCSTR optional
  Buffer: PAnsiChar;   // LPSTR out
  BufferLen: DWORD;   // DWORD
  ulFlags: DWORD;   // DWORD
  hMachine: NativeInt   // INT_PTR optional
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_Device_ID_List_ExA';
result := DllCall("CFGMGR32\CM_Get_Device_ID_List_ExA"
    , "AStr", pszFilter   ; LPCSTR optional
    , "Ptr", Buffer   ; LPSTR out
    , "UInt", BufferLen   ; DWORD
    , "UInt", ulFlags   ; DWORD
    , "Ptr", hMachine   ; INT_PTR optional
    , "UInt")   ; return: CONFIGRET
●CM_Get_Device_ID_List_ExA(pszFilter, Buffer, BufferLen, ulFlags, hMachine) = DLL("CFGMGR32.dll", "dword CM_Get_Device_ID_List_ExA(char*, char*, dword, dword, int)")
# 呼び出し: CM_Get_Device_ID_List_ExA(pszFilter, Buffer, BufferLen, ulFlags, hMachine)
# pszFilter : LPCSTR optional -> "char*"
# Buffer : LPSTR out -> "char*"
# BufferLen : DWORD -> "dword"
# ulFlags : DWORD -> "dword"
# hMachine : INT_PTR optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

foreign import stdcall safe "CM_Get_Device_ID_List_ExA"
  c_CM_Get_Device_ID_List_ExA :: CString -> CString -> Word32 -> Word32 -> CIntPtr -> IO Word32
-- pszFilter : LPCSTR optional -> CString
-- Buffer : LPSTR out -> CString
-- BufferLen : DWORD -> Word32
-- ulFlags : DWORD -> Word32
-- hMachine : INT_PTR optional -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cm_get_device_id_list_exa =
  foreign "CM_Get_Device_ID_List_ExA"
    (string @-> string @-> uint32_t @-> uint32_t @-> intptr_t @-> returning uint32_t)
(* pszFilter : LPCSTR optional -> string *)
(* Buffer : LPSTR out -> string *)
(* BufferLen : DWORD -> uint32_t *)
(* ulFlags : DWORD -> uint32_t *)
(* hMachine : INT_PTR optional -> intptr_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_List_ExA" cm-get-device-id-list-ex-a :convention :stdcall) :uint32
  (psz-filter :string)   ; LPCSTR optional
  (buffer :pointer)   ; LPSTR out
  (buffer-len :uint32)   ; DWORD
  (ul-flags :uint32)   ; DWORD
  (h-machine :int64))   ; INT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CM_Get_Device_ID_List_ExA = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Get_Device_ID_List_ExA(LPCSTR pszFilter, LPSTR Buffer, DWORD BufferLen, DWORD ulFlags, LPARAM hMachine)');
# my $ret = $CM_Get_Device_ID_List_ExA->Call($pszFilter, $Buffer, $BufferLen, $ulFlags, $hMachine);
# pszFilter : LPCSTR optional -> LPCSTR
# Buffer : LPSTR out -> LPSTR
# BufferLen : DWORD -> DWORD
# ulFlags : DWORD -> DWORD
# hMachine : INT_PTR optional -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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