ホーム › UI.WindowsAndMessaging › IsDialogMessageA

IsDialogMessageA

関数

メッセージがダイアログ用か判定し処理する(ANSI版)。

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

シグネチャ

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

BOOL IsDialogMessageA(
    HWND hDlg,
    MSG* lpMsg
);

パラメーター

名前	型	方向	説明
hDlg	HWND	in	ダイアログボックスへのハンドルです。
lpMsg	MSG*	in	チェック対象のメッセージを格納した MSG 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

メッセージが指定したダイアログボックス宛てかどうかを判定し、宛てであればそのメッセージを処理します。(ANSI)

戻り値

型: BOOL

メッセージが処理された場合、戻り値は 0 以外になります。

メッセージが処理されなかった場合、戻り値は 0 になります。

解説(Remarks)

IsDialogMessage 関数はモードレスダイアログボックスを対象としていますが、コントロールを含む任意のウィンドウに対して使用できます。これにより、ダイアログボックスと同じキーボード選択操作をウィンドウに提供できます。

IsDialogMessage はメッセージを処理する際、キーボードメッセージを確認し、それらを対応するダイアログボックスの選択操作に変換します。たとえば、TAB キーを押すと次のコントロールまたはコントロールのグループが選択され、下方向キーを押すとグループ内の次のコントロールが選択されます。

IsDialogMessage 関数はメッセージの変換とディスパッチを必要に応じてすべて実行するため、IsDialogMessage が処理したメッセージを TranslateMessage 関数や DispatchMessage 関数に渡してはなりません。

IsDialogMessage は、どのキーを処理すべきかを判断するために、ダイアログボックスプロシージャへ WM_GETDLGCODE メッセージを送信します。

IsDialogMessage は、ウィンドウへ DM_GETDEFID および DM_SETDEFID メッセージを送信することがあります。これらのメッセージは Winuser.h ヘッダーファイルで WM_USER および WM_USER + 1 として定義されているため、同じ値を持つアプリケーション定義のメッセージと競合する可能性があります。

メモ

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

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

各言語での呼び出し定義

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

BOOL IsDialogMessageA(
    HWND hDlg,
    MSG* lpMsg
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool IsDialogMessageA(
    IntPtr hDlg,   // HWND
    IntPtr lpMsg   // MSG*
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function IsDialogMessageA(
    hDlg As IntPtr,   ' HWND
    lpMsg As IntPtr   ' MSG*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hDlg : HWND
' lpMsg : MSG*
Declare PtrSafe Function IsDialogMessageA Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal lpMsg As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

IsDialogMessageA = ctypes.windll.user32.IsDialogMessageA
IsDialogMessageA.restype = wintypes.BOOL
IsDialogMessageA.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_void_p,  # lpMsg : MSG*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
IsDialogMessageA = Fiddle::Function.new(
  lib['IsDialogMessageA'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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