IsAccelerator

関数

メッセージがアクセラレータテーブルに該当するか判定する。

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

シグネチャ

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

BOOL IsAccelerator(
    HACCEL hAccel,
    INT cAccelEntries,
    MSG* lpMsg,
    WORD* lpwCmd
);

パラメーター

名前	型	方向	説明
hAccel	HACCEL	in	アクセラレータテーブルへのハンドルです。
cAccelEntries	INT	in	アクセラレータテーブル内のエントリ数です。
lpMsg	MSG*	in	変換対象のキーストロークメッセージへのポインタです。
lpwCmd	WORD*	out	キーストロークに対応するアクセラレータが存在する場合に、対応するコマンド識別子を受け取る変数へのポインタです。このパラメータは NULL でもかまいません。

戻り値の型: BOOL

公式ドキュメント

指定されたキーストロークが、指定されたアクセラレータテーブル内のアクセラレータに対応するかどうかを判定します。

戻り値

メッセージがオブジェクトアプリケーション宛てである場合、戻り値は TRUE です。メッセージがオブジェクト宛てではなく、コンテナへ転送すべき場合、戻り値は FALSE です。

解説(Remarks)

オブジェクトがインプレースでアクティブな間は、オブジェクトが常に最初にキーストロークをアクセラレータへ変換する機会を持ちます。キーストロークがそのアクセラレータのいずれかに対応する場合、たとえ TranslateAccelerator 関数の呼び出しが失敗したとしても、オブジェクトは OleTranslateAccelerator 関数を呼び出してはなりません。この方法でキーストロークを処理しないと、一貫性のない動作につながる可能性があります。

キーストロークがオブジェクトのアクセラレータのいずれにも該当しない場合、オブジェクトは OleTranslateAccelerator を呼び出し、コンテナにアクセラレータ変換を試行させる必要があります。

オブジェクトのサーバーは、アクセラレータメッセージが自分宛てかどうかを判定するために IsAccelerator を呼び出すことができます。一部のサーバーは独自にアクセラレータ変換を行い、TranslateAccelerator を呼び出しません。そのようなアプリケーションは、すでに必要な情報を持っているため、IsAccelerator を呼び出しません。

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

各言語での呼び出し定義

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

BOOL IsAccelerator(
    HACCEL hAccel,
    INT cAccelEntries,
    MSG* lpMsg,
    WORD* lpwCmd
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern bool IsAccelerator(
    IntPtr hAccel,   // HACCEL
    int cAccelEntries,   // INT
    IntPtr lpMsg,   // MSG*
    out ushort lpwCmd   // WORD* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function IsAccelerator(
    hAccel As IntPtr,   ' HACCEL
    cAccelEntries As Integer,   ' INT
    lpMsg As IntPtr,   ' MSG*
    <Out> ByRef lpwCmd As UShort   ' WORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hAccel : HACCEL
' cAccelEntries : INT
' lpMsg : MSG*
' lpwCmd : WORD* out
Declare PtrSafe Function IsAccelerator Lib "ole32" ( _
    ByVal hAccel As LongPtr, _
    ByVal cAccelEntries As Long, _
    ByVal lpMsg As LongPtr, _
    ByRef lpwCmd As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

IsAccelerator = ctypes.windll.ole32.IsAccelerator
IsAccelerator.restype = wintypes.BOOL
IsAccelerator.argtypes = [
    wintypes.HANDLE,  # hAccel : HACCEL
    ctypes.c_int,  # cAccelEntries : INT
    ctypes.c_void_p,  # lpMsg : MSG*
    ctypes.POINTER(ctypes.c_ushort),  # lpwCmd : WORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
IsAccelerator = Fiddle::Function.new(
  lib['IsAccelerator'],
  [
    Fiddle::TYPE_VOIDP,  # hAccel : HACCEL
    Fiddle::TYPE_INT,  # cAccelEntries : INT
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
    Fiddle::TYPE_VOIDP,  # lpwCmd : WORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn IsAccelerator(
        hAccel: *mut core::ffi::c_void,  // HACCEL
        cAccelEntries: i32,  // INT
        lpMsg: *mut MSG,  // MSG*
        lpwCmd: *mut u16  // WORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("OLE32.dll")]
public static extern bool IsAccelerator(IntPtr hAccel, int cAccelEntries, IntPtr lpMsg, out ushort lpwCmd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_IsAccelerator' -Namespace Win32 -PassThru
# $api::IsAccelerator(hAccel, cAccelEntries, lpMsg, lpwCmd)

#uselib "OLE32.dll"
#func global IsAccelerator "IsAccelerator" sptr, sptr, sptr, sptr
; IsAccelerator hAccel, cAccelEntries, varptr(lpMsg), varptr(lpwCmd)   ; 戻り値は stat
; hAccel : HACCEL -> "sptr"
; cAccelEntries : INT -> "sptr"
; lpMsg : MSG* -> "sptr"
; lpwCmd : WORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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