ホーム › UI.WindowsAndMessaging › CallMsgFilterW

CallMsgFilterW

関数

メッセージフィルタフックを呼び出す(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL CallMsgFilterW(
    MSG* lpMsg,
    INT nCode
);

パラメーター

名前	型	方向	説明
lpMsg	MSG*	in	フックプロシージャに渡すメッセージを格納した MSG 構造体へのポインターです。
nCode	INT	in	メッセージの処理方法を判断するためにフックプロシージャが使用する、アプリケーション定義のコードです。このコードには、WH_SYSMSGFILTER および WH_MSGFILTER フックに関連付けられたシステム定義のフックコード(MSGF_ および HC_)と同じ値を指定してはなりません。

戻り値の型: BOOL

公式ドキュメント

指定したメッセージとフックコードを、WH_SYSMSGFILTER および WH_MSGFILTER フックに関連付けられたフックプロシージャに渡します。(Unicode)

戻り値

型: BOOL

アプリケーションがメッセージをさらに処理すべき場合、戻り値は 0 になります。

アプリケーションがメッセージをこれ以上処理すべきでない場合、戻り値は 0 以外になります。

解説(Remarks)

システムは CallMsgFilter を呼び出し、ダイアログボックス、メッセージボックス、メニュー、スクロールバーの内部処理中、またはユーザーが ALT+TAB キーの組み合わせを押して別のウィンドウをアクティブにしたときに、アプリケーションがメッセージの流れを検査および制御できるようにします。

このフックプロシージャをインストールするには、SetWindowsHookEx 関数を使用します。

例

例については、WH_MSGFILTER and WH_SYSMSGFILTER Hooks を参照してください。

メモ

winuser.h ヘッダーは CallMsgFilter をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

BOOL CallMsgFilterW(
    MSG* lpMsg,
    INT nCode
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool CallMsgFilterW(
    IntPtr lpMsg,   // MSG*
    int nCode   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function CallMsgFilterW(
    lpMsg As IntPtr,   ' MSG*
    nCode As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpMsg : MSG*
' nCode : INT
Declare PtrSafe Function CallMsgFilterW Lib "user32" ( _
    ByVal lpMsg As LongPtr, _
    ByVal nCode 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

CallMsgFilterW = ctypes.windll.user32.CallMsgFilterW
CallMsgFilterW.restype = wintypes.BOOL
CallMsgFilterW.argtypes = [
    ctypes.c_void_p,  # lpMsg : MSG*
    ctypes.c_int,  # nCode : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
CallMsgFilterW = Fiddle::Function.new(
  lib['CallMsgFilterW'],
  [
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
    Fiddle::TYPE_INT,  # nCode : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn CallMsgFilterW(
        lpMsg: *mut MSG,  // MSG*
        nCode: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern bool CallMsgFilterW(IntPtr lpMsg, int nCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CallMsgFilterW' -Namespace Win32 -PassThru
# $api::CallMsgFilterW(lpMsg, nCode)

#uselib "USER32.dll"
#func global CallMsgFilterW "CallMsgFilterW" wptr, wptr
; CallMsgFilterW varptr(lpMsg), nCode   ; 戻り値は stat
; lpMsg : MSG* -> "wptr"
; nCode : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global CallMsgFilterW "CallMsgFilterW" var, int
; res = CallMsgFilterW(lpMsg, nCode)
; lpMsg : MSG* -> "var"
; nCode : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global CallMsgFilterW "CallMsgFilterW" sptr, int
; res = CallMsgFilterW(varptr(lpMsg), nCode)
; lpMsg : MSG* -> "sptr"
; nCode : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。