ホーム › UI.WindowsAndMessaging › TranslateAcceleratorA

TranslateAcceleratorA

関数

アクセラレータキーをコマンドに変換し送出する(ANSI)。

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

シグネチャ

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

INT TranslateAcceleratorA(
    HWND hWnd,
    HACCEL hAccTable,
    MSG* lpMsg
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	メッセージを変換する対象のウィンドウへのハンドル。
hAccTable	HACCEL	in	アクセラレータテーブルへのハンドル。アクセラレータテーブルは、LoadAccelerators 関数の呼び出しによって読み込まれているか、CreateAcceleratorTable 関数の呼び出しによって作成されている必要があります。
lpMsg	MSG*	in	呼び出し元スレッドのメッセージキューから GetMessage 関数または PeekMessage 関数を使用して取得したメッセージ情報を含む MSG 構造体へのポインター。

戻り値の型: INT

公式ドキュメント

メニューコマンドのアクセラレータキーを処理します。(ANSI)

戻り値

型: int

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数が送信するメッセージを、メニューやコントロールから送信されるメッセージと区別するために、WM_COMMAND メッセージまたは WM_SYSCOMMAND メッセージの wParam パラメーターの上位ワードには値 1 が格納されます。

ウィンドウメニューから項目を選択するために使用されるアクセラレータキーの組み合わせは WM_SYSCOMMAND メッセージに変換され、それ以外のアクセラレータキーの組み合わせはすべて WM_COMMAND メッセージに変換されます。

TranslateAccelerator が 0 以外の値を返し、メッセージが変換された場合、アプリケーションはそのメッセージを再度処理するために TranslateMessage 関数を使用してはなりません。

アクセラレータがメニューコマンドに対応している必要はありません。

アクセラレータコマンドがメニュー項目に対応している場合、ユーザーがメニューを表示しようとしているかのように、アプリケーションには WM_INITMENU および WM_INITMENUPOPUP メッセージが送信されます。ただし、次のいずれかの条件が存在する場合、これらのメッセージは送信されません。

ウィンドウが無効になっている。
アクセラレータキーの組み合わせがウィンドウメニューの項目に対応しておらず、かつウィンドウが最小化されている。
マウスキャプチャが有効になっている。マウスキャプチャの詳細については、SetCapture 関数を参照してください。

指定したウィンドウがアクティブウィンドウであり、いずれのウィンドウもキーボードフォーカスを持っていない場合(ウィンドウが最小化されている場合は通常このようになります)、TranslateAccelerator は WM_KEYUP および WM_KEYDOWN メッセージの代わりに、 WM_SYSKEYUP および WM_SYSKEYDOWN メッセージを変換します。

メニューを所有するウィンドウが最小化されているときに、メニュー項目に対応するアクセラレータキー操作が発生した場合、TranslateAccelerator は WM_COMMAND メッセージを送信しません。ただし、ウィンドウのメニューや ウィンドウメニューのいずれの項目にも一致しないアクセラレータキー操作が発生した場合、関数はウィンドウが最小化されていても WM_COMMAND メッセージを送信します。

例

例については、フォント属性のアクセラレータの作成を参照してください。

メモ

winuser.h ヘッダーは TranslateAccelerator を、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>

INT TranslateAcceleratorA(
    HWND hWnd,
    HACCEL hAccTable,
    MSG* lpMsg
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int TranslateAcceleratorA(
    IntPtr hWnd,   // HWND
    IntPtr hAccTable,   // HACCEL
    IntPtr lpMsg   // MSG*
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TranslateAcceleratorA(
    hWnd As IntPtr,   ' HWND
    hAccTable As IntPtr,   ' HACCEL
    lpMsg As IntPtr   ' MSG*
) As Integer
End Function

' hWnd : HWND
' hAccTable : HACCEL
' lpMsg : MSG*
Declare PtrSafe Function TranslateAcceleratorA Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal hAccTable 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

TranslateAcceleratorA = ctypes.windll.user32.TranslateAcceleratorA
TranslateAcceleratorA.restype = ctypes.c_int
TranslateAcceleratorA.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.HANDLE,  # hAccTable : HACCEL
    ctypes.c_void_p,  # lpMsg : MSG*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
TranslateAcceleratorA = Fiddle::Function.new(
  lib['TranslateAcceleratorA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # hAccTable : HACCEL
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int TranslateAcceleratorA(IntPtr hWnd, IntPtr hAccTable, IntPtr lpMsg);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_TranslateAcceleratorA' -Namespace Win32 -PassThru
# $api::TranslateAcceleratorA(hWnd, hAccTable, lpMsg)

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

出力引数:

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