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

CM_NOTIFY_FILTER

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 24 バイト / x86: 20 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
cbSizeDWORD4+0+0構造体のサイズです。
FlagsDWORD4+4+4

次のフラグを 0 個以上組み合わせた値です。

CM_NOTIFY_FILTER_FLAG_ALL_INTERFACE_CLASSES

すべてのデバイスインターフェイスクラスの PnP イベントに関する通知を受け取るために登録します。pFilter->u.DeviceInterface.ClassGuid のメモリは 0 でなければなりません。このフラグを CM_NOTIFY_FILTER_FLAG_ALL_DEVICE_INSTANCES と併用しないでください。このフラグは pFilter->FilterType が CM_NOTIFY_FILTER_TYPE_DEVICEINTERFACE である場合にのみ有効です。

CM_NOTIFY_FILTER_FLAG_ALL_DEVICE_INSTANCES

すべてのデバイスの PnP イベントに関する通知を受け取るために登録します。pFilter->u.DeviceInstance.InstanceId は空の文字列でなければなりません。このフラグを CM_NOTIFY_FILTER_FLAG_ALL_INTERFACE_CLASSES と併用しないでください。このフラグは pFilter->FilterType が CM_NOTIFY_FILTER_TYPE_DEVICEINSTANCE である場合にのみ有効です。

FilterTypeCM_NOTIFY_FILTER_TYPE4+8+8

次のいずれかの値でなければなりません。

CM_NOTIFY_FILTER_TYPE_DEVICEINTERFACE

デバイスインターフェイスイベントの通知を登録します。pFilter->u.DeviceInterface.ClassGuid には、通知を受け取るデバイスインターフェイスクラスの GUID を設定します。

CM_NOTIFY_FILTER_TYPE_DEVICEHANDLE

デバイスハンドルイベントの通知を登録します。pFilter->u.DeviceHandle.hTarget には、通知を受け取るデバイスへのハンドルを設定しなければなりません。このハンドルは、CM_Register_Notification の呼び出しが完了するまで、そのデバイスに対する有効なハンドルのままでなければなりません。ただし、CM_Register_Notification から制御が戻った後は、登録が通知を受け取る機能に影響を与えることなくハンドルを閉じることができます。

CM_NOTIFY_FILTER_TYPE_DEVICEINSTANCE

デバイスインスタンスイベントの通知を登録します。pFilter->u.DeviceInstance.InstanceId には、通知を受け取るデバイスのデバイスインスタンス ID を設定します。

ReservedDWORD4+12+120 を設定します。
u_u_e__Union8/4+16+16通知を受け取るデバイスに関する情報を格納する共用体です。

共用体: _u_e__Union x64 8B / x86 4B

フィールド型サイズx64x86説明
DeviceInterface_DeviceInterface_e__Struct8/4+0+0
DeviceHandle_DeviceHandle_e__Struct8/4+0+0通知を受け取るデバイスへのハンドルです。
DeviceInstance_DeviceInstance_e__Struct8/4+0+0通知を受け取るデバイスのデバイスインスタンス ID です。

公式ドキュメント

デバイス通知フィルター構造体

解説(Remarks)

ドライバーが CM_Register_Notification 関数を呼び出すときは、pFilter パラメーターに CM_NOTIFY_FILTER 構造体へのポインターを指定します。

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

各言語での定義

#include <windows.h>

// CM_NOTIFY_FILTER  (x64 24 / x86 20 バイト)
typedef struct CM_NOTIFY_FILTER {
    DWORD cbSize;
    DWORD Flags;
    CM_NOTIFY_FILTER_TYPE FilterType;
    DWORD Reserved;
    _u_e__Union u;
} CM_NOTIFY_FILTER;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CM_NOTIFY_FILTER
{
    public uint cbSize;
    public uint Flags;
    public int FilterType;
    public uint Reserved;
    public _u_e__Union u;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CM_NOTIFY_FILTER
    Public cbSize As UInteger
    Public Flags As UInteger
    Public FilterType As Integer
    Public Reserved As UInteger
    Public u As _u_e__Union
End Structure
import ctypes
from ctypes import wintypes

class CM_NOTIFY_FILTER(ctypes.Structure):
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("Flags", wintypes.DWORD),
        ("FilterType", ctypes.c_int),
        ("Reserved", wintypes.DWORD),
        ("u", _u_e__Union),
    ]
#[repr(C)]
pub struct CM_NOTIFY_FILTER {
    pub cbSize: u32,
    pub Flags: u32,
    pub FilterType: i32,
    pub Reserved: u32,
    pub u: _u_e__Union,
}
import "golang.org/x/sys/windows"

type CM_NOTIFY_FILTER struct {
	cbSize uint32
	Flags uint32
	FilterType int32
	Reserved uint32
	u _u_e__Union
}
type
  CM_NOTIFY_FILTER = record
    cbSize: DWORD;
    Flags: DWORD;
    FilterType: Integer;
    Reserved: DWORD;
    u: _u_e__Union;
  end;
const CM_NOTIFY_FILTER = extern struct {
    cbSize: u32,
    Flags: u32,
    FilterType: i32,
    Reserved: u32,
    u: _u_e__Union,
};
type
  CM_NOTIFY_FILTER {.bycopy.} = object
    cbSize: uint32
    Flags: uint32
    FilterType: int32
    Reserved: uint32
    u: _u_e__Union
struct CM_NOTIFY_FILTER
{
    uint cbSize;
    uint Flags;
    int FilterType;
    uint Reserved;
    _u_e__Union u;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CM_NOTIFY_FILTER サイズ: 20 バイト(x86)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Flags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; FilterType : CM_NOTIFY_FILTER_TYPE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Reserved : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; u : _u_e__Union (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CM_NOTIFY_FILTER サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Flags : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; FilterType : CM_NOTIFY_FILTER_TYPE (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; Reserved : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; u : _u_e__Union (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CM_NOTIFY_FILTER
    #field int cbSize
    #field int Flags
    #field int FilterType
    #field int Reserved
    #field byte u 8
#endstruct

stdim st, CM_NOTIFY_FILTER        ; NSTRUCT 変数を確保
st->cbSize = 100
mes "cbSize=" + st->cbSize
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。