Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › TranslateAcceleratorW

TranslateAcceleratorW

関数
アクセラレータキーのメッセージを対応するコマンドメッセージに変換する。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

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

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

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

解説(Remarks)

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

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

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

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

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

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT TranslateAcceleratorW(
    HWND hWnd,
    HACCEL hAccTable,
    MSG* lpMsg
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int TranslateAcceleratorW(
    IntPtr hWnd,   // HWND
    IntPtr hAccTable,   // HACCEL
    IntPtr lpMsg   // MSG*
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TranslateAcceleratorW(
    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 TranslateAcceleratorW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal hAccTable As LongPtr, _
    ByVal lpMsg As LongPtr) 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

TranslateAcceleratorW = ctypes.windll.user32.TranslateAcceleratorW
TranslateAcceleratorW.restype = ctypes.c_int
TranslateAcceleratorW.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')
TranslateAcceleratorW = Fiddle::Function.new(
  lib['TranslateAcceleratorW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # hAccTable : HACCEL
    Fiddle::TYPE_VOIDP,  # lpMsg : MSG*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn TranslateAcceleratorW(
        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.Unicode, SetLastError = true)]
public static extern int TranslateAcceleratorW(IntPtr hWnd, IntPtr hAccTable, IntPtr lpMsg);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_TranslateAcceleratorW' -Namespace Win32 -PassThru
# $api::TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
#uselib "USER32.dll"
#func global TranslateAcceleratorW "TranslateAcceleratorW" wptr, wptr, wptr
; TranslateAcceleratorW hWnd, hAccTable, varptr(lpMsg)   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; hAccTable : HACCEL -> "wptr"
; lpMsg : MSG* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global TranslateAcceleratorW "TranslateAcceleratorW" sptr, sptr, var
; res = TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
; hWnd : HWND -> "sptr"
; hAccTable : HACCEL -> "sptr"
; lpMsg : MSG* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT TranslateAcceleratorW(HWND hWnd, HACCEL hAccTable, MSG* lpMsg)
#uselib "USER32.dll"
#cfunc global TranslateAcceleratorW "TranslateAcceleratorW" intptr, intptr, var
; res = TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
; hWnd : HWND -> "intptr"
; hAccTable : HACCEL -> "intptr"
; lpMsg : MSG* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procTranslateAcceleratorW = user32.NewProc("TranslateAcceleratorW")
)

// hWnd (HWND), hAccTable (HACCEL), lpMsg (MSG*)
r1, _, err := procTranslateAcceleratorW.Call(
	uintptr(hWnd),
	uintptr(hAccTable),
	uintptr(lpMsg),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function TranslateAcceleratorW(
  hWnd: THandle;   // HWND
  hAccTable: THandle;   // HACCEL
  lpMsg: Pointer   // MSG*
): Integer; stdcall;
  external 'USER32.dll' name 'TranslateAcceleratorW';
result := DllCall("USER32\TranslateAcceleratorW"
    , "Ptr", hWnd   ; HWND
    , "Ptr", hAccTable   ; HACCEL
    , "Ptr", lpMsg   ; MSG*
    , "Int")   ; return: INT
●TranslateAcceleratorW(hWnd, hAccTable, lpMsg) = DLL("USER32.dll", "int TranslateAcceleratorW(void*, void*, void*)")
# 呼び出し: TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
# hWnd : HWND -> "void*"
# hAccTable : HACCEL -> "void*"
# lpMsg : MSG* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn TranslateAcceleratorW(
    hWnd: ?*anyopaque, // HWND
    hAccTable: ?*anyopaque, // HACCEL
    lpMsg: [*c]MSG // MSG*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc TranslateAcceleratorW(
    hWnd: pointer,  # HWND
    hAccTable: pointer,  # HACCEL
    lpMsg: ptr MSG  # MSG*
): int32 {.importc: "TranslateAcceleratorW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int TranslateAcceleratorW(
    void* hWnd,   // HWND
    void* hAccTable,   // HACCEL
    MSG* lpMsg   // MSG*
);
ccall((:TranslateAcceleratorW, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{MSG}),
      hWnd, hAccTable, lpMsg)
# hWnd : HWND -> Ptr{Cvoid}
# hAccTable : HACCEL -> Ptr{Cvoid}
# lpMsg : MSG* -> Ptr{MSG}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t TranslateAcceleratorW(
    void* hWnd,
    void* hAccTable,
    void* lpMsg);
]]
local user32 = ffi.load("user32")
-- user32.TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
-- hWnd : HWND
-- hAccTable : HACCEL
-- lpMsg : MSG*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const TranslateAcceleratorW = lib.func('__stdcall', 'TranslateAcceleratorW', 'int32_t', ['void *', 'void *', 'void *']);
// TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
// hWnd : HWND -> 'void *'
// hAccTable : HACCEL -> 'void *'
// lpMsg : MSG* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  TranslateAcceleratorW: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.TranslateAcceleratorW(hWnd, hAccTable, lpMsg)
// hWnd : HWND -> "pointer"
// hAccTable : HACCEL -> "pointer"
// lpMsg : MSG* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TranslateAcceleratorW(
    void* hWnd,
    void* hAccTable,
    void* lpMsg);
C, "USER32.dll");
// $ffi->TranslateAcceleratorW(hWnd, hAccTable, lpMsg);
// hWnd : HWND
// hAccTable : HACCEL
// lpMsg : MSG*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
    int TranslateAcceleratorW(
        Pointer hWnd,   // HWND
        Pointer hAccTable,   // HACCEL
        Pointer lpMsg   // MSG*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun TranslateAcceleratorW = TranslateAcceleratorW(
    hWnd : Void*,   # HWND
    hAccTable : Void*,   # HACCEL
    lpMsg : MSG*   # MSG*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TranslateAcceleratorWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef TranslateAcceleratorWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final TranslateAcceleratorW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<TranslateAcceleratorWNative, TranslateAcceleratorWDart>('TranslateAcceleratorW');
// hWnd : HWND -> Pointer<Void>
// hAccTable : HACCEL -> Pointer<Void>
// lpMsg : MSG* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TranslateAcceleratorW(
  hWnd: THandle;   // HWND
  hAccTable: THandle;   // HACCEL
  lpMsg: Pointer   // MSG*
): Integer; stdcall;
  external 'USER32.dll' name 'TranslateAcceleratorW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TranslateAcceleratorW"
  c_TranslateAcceleratorW :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- hWnd : HWND -> Ptr ()
-- hAccTable : HACCEL -> Ptr ()
-- lpMsg : MSG* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let translateacceleratorw =
  foreign "TranslateAcceleratorW"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* hAccTable : HACCEL -> (ptr void) *)
(* lpMsg : MSG* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("TranslateAcceleratorW" translate-accelerator-w :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (h-acc-table :pointer)   ; HACCEL
  (lp-msg :pointer))   ; MSG*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TranslateAcceleratorW = Win32::API::More->new('USER32',
    'int TranslateAcceleratorW(HANDLE hWnd, HANDLE hAccTable, LPVOID lpMsg)');
# my $ret = $TranslateAcceleratorW->Call($hWnd, $hAccTable, $lpMsg);
# hWnd : HWND -> HANDLE
# hAccTable : HACCEL -> HANDLE
# lpMsg : MSG* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型