ホーム › Devices.DeviceAndDriverInstallation › CM_Enumerate_Classes_Ex

CM_Enumerate_Classes_Ex

関数

指定マシンのデバイスセットアップクラスを列挙する。

DLLCFGMGR32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

CONFIGRET CM_Enumerate_Classes_Ex(
    DWORD ulClassIndex,
    GUID* ClassGuid,
    CM_ENUMERATE_FLAGS ulFlags,
    INT_PTR hMachine   // optional
);

パラメーター

名前	型	方向	説明
ulClassIndex	DWORD	in	コンピューターのデバイスクラス一覧に対する、呼び出し元が指定するインデックスです。詳細については、後述の解説セクションを参照してください。
ClassGuid	GUID*	out	デバイスクラスの GUID を受け取る GUID 構造体 (Microsoft Windows SDK で説明されています) のアドレスです。呼び出し元が指定します。
ulFlags	CM_ENUMERATE_FLAGS	in	Windows 8 以降では、呼び出し元は次のフラグを指定できます。 CM_ENUMERATE_CLASSES_INSTALLER デバイスセットアップクラスを列挙します。 CM_ENUMERATE_CLASSES_INTERFACE デバイスインターフェイスクラスを列挙します。それ以外の場合は、0 を設定してください。
hMachine	INT_PTR	inoptional	呼び出し元が指定するコンピューターのハンドルです。事前に CM_Connect_Machine を呼び出して取得します。注意 Windows 8 および Windows Server 2012 以降では、この機能が削除されたため、この関数を使用してリモートコンピューターにアクセスすることはサポートされていません。

戻り値の型: CONFIGRET

公式ドキュメント

CM_Enumerate_Classes_Ex 関数は、繰り返し呼び出すことで、ローカルまたはリモートのコンピューターにインストールされているデバイスクラスを、各クラスの GUID を返すことによって列挙します。

戻り値

操作に成功した場合、この関数は CR_SUCCESS を返します。失敗した場合は、Cfgmgr32.h で定義されている CR_ プレフィックスの付いたエラーコードのいずれかを返します。

解説(Remarks)

ローカルまたはリモートのコンピューターのデバイスクラスを列挙するには、ulClassIndex のインデックス値を 0 から開始し、呼び出しごとにインデックス値を 1 ずつ増やしながら、関数が CR_NO_SUCH_VALUE を返すまで CM_Enumerate_Classes_Ex を繰り返し呼び出します。一部のインデックス値は、無効なクラスデータを含むリストのエントリを表している場合があり、その場合この関数は CR_INVALID_DATA を返します。この戻り値は無視して構いません。

この関数で取得したクラス GUID は、デバイスインストール関数への入力として使用できます。

Windows 8 以降のオペレーティングシステムでは、呼び出し元は ulFlags メンバーを使用して、CM_Enumerate_Classes_Ex が返すデバイスクラスを指定できます。Windows 8 より前では、CM_Enumerate_Classes_Ex はデバイスセットアップクラスのみを返していました。

リモートコンピューターにアクセスする機能は Windows 8 および Windows Server 2012 以降のオペレーティングシステムでは削除されているため、これらのバージョンの Windows で実行する場合はリモートコンピューターにアクセスできません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

CONFIGRET CM_Enumerate_Classes_Ex(
    DWORD ulClassIndex,
    GUID* ClassGuid,
    CM_ENUMERATE_FLAGS ulFlags,
    INT_PTR hMachine   // optional
);

[DllImport("CFGMGR32.dll", ExactSpelling = true)]
static extern uint CM_Enumerate_Classes_Ex(
    uint ulClassIndex,   // DWORD
    out Guid ClassGuid,   // GUID* out
    uint ulFlags,   // CM_ENUMERATE_FLAGS
    IntPtr hMachine   // INT_PTR optional
);

<DllImport("CFGMGR32.dll", ExactSpelling:=True)>
Public Shared Function CM_Enumerate_Classes_Ex(
    ulClassIndex As UInteger,   ' DWORD
    <Out> ByRef ClassGuid As Guid,   ' GUID* out
    ulFlags As UInteger,   ' CM_ENUMERATE_FLAGS
    hMachine As IntPtr   ' INT_PTR optional
) As UInteger
End Function

' ulClassIndex : DWORD
' ClassGuid : GUID* out
' ulFlags : CM_ENUMERATE_FLAGS
' hMachine : INT_PTR optional
Declare PtrSafe Function CM_Enumerate_Classes_Ex Lib "cfgmgr32" ( _
    ByVal ulClassIndex As Long, _
    ByVal ClassGuid As LongPtr, _
    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_Enumerate_Classes_Ex = ctypes.windll.cfgmgr32.CM_Enumerate_Classes_Ex
CM_Enumerate_Classes_Ex.restype = wintypes.DWORD
CM_Enumerate_Classes_Ex.argtypes = [
    wintypes.DWORD,  # ulClassIndex : DWORD
    ctypes.c_void_p,  # ClassGuid : GUID* out
    wintypes.DWORD,  # ulFlags : CM_ENUMERATE_FLAGS
    ctypes.c_ssize_t,  # hMachine : INT_PTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CFGMGR32.dll')
CM_Enumerate_Classes_Ex = Fiddle::Function.new(
  lib['CM_Enumerate_Classes_Ex'],
  [
    -Fiddle::TYPE_INT,  # ulClassIndex : DWORD
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID* out
    -Fiddle::TYPE_INT,  # ulFlags : CM_ENUMERATE_FLAGS
    Fiddle::TYPE_INTPTR_T,  # hMachine : INT_PTR optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "cfgmgr32")]
extern "system" {
    fn CM_Enumerate_Classes_Ex(
        ulClassIndex: u32,  // DWORD
        ClassGuid: *mut GUID,  // GUID* out
        ulFlags: u32,  // CM_ENUMERATE_FLAGS
        hMachine: isize  // INT_PTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("CFGMGR32.dll")]
public static extern uint CM_Enumerate_Classes_Ex(uint ulClassIndex, out Guid ClassGuid, uint ulFlags, IntPtr hMachine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Enumerate_Classes_Ex' -Namespace Win32 -PassThru
# $api::CM_Enumerate_Classes_Ex(ulClassIndex, ClassGuid, ulFlags, hMachine)

#uselib "CFGMGR32.dll"
#func global CM_Enumerate_Classes_Ex "CM_Enumerate_Classes_Ex" sptr, sptr, sptr, sptr
; CM_Enumerate_Classes_Ex ulClassIndex, varptr(ClassGuid), ulFlags, hMachine   ; 戻り値は stat
; ulClassIndex : DWORD -> "sptr"
; ClassGuid : GUID* out -> "sptr"
; ulFlags : CM_ENUMERATE_FLAGS -> "sptr"
; hMachine : INT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "CFGMGR32.dll"
#cfunc global CM_Enumerate_Classes_Ex "CM_Enumerate_Classes_Ex" int, var, int, sptr
; res = CM_Enumerate_Classes_Ex(ulClassIndex, ClassGuid, ulFlags, hMachine)
; ulClassIndex : DWORD -> "int"
; ClassGuid : GUID* out -> "var"
; ulFlags : CM_ENUMERATE_FLAGS -> "int"
; hMachine : INT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "CFGMGR32.dll"
#cfunc global CM_Enumerate_Classes_Ex "CM_Enumerate_Classes_Ex" int, sptr, int, sptr
; res = CM_Enumerate_Classes_Ex(ulClassIndex, varptr(ClassGuid), ulFlags, hMachine)
; ulClassIndex : DWORD -> "int"
; ClassGuid : GUID* out -> "sptr"
; ulFlags : CM_ENUMERATE_FLAGS -> "int"
; hMachine : INT_PTR optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。