ホーム › UI.WindowsAndMessaging › TranslateMessage

TranslateMessage

関数

仮想キーメッセージを文字メッセージに変換しキューへ送る。

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

シグネチャ

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

BOOL TranslateMessage(
    const MSG* lpMsg
);

パラメーター

名前	型	方向	説明
lpMsg	MSG*	in	呼び出し元スレッドのメッセージキューから GetMessage または PeekMessage 関数によって取得されたメッセージ情報を含む MSG 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

仮想キーメッセージを文字メッセージに変換します。文字メッセージは呼び出し元スレッドのメッセージキューにポストされ、そのスレッドが次に GetMessage または PeekMessage 関数を呼び出したときに読み取られます。

戻り値

型: BOOL

メッセージが変換された場合(つまり文字メッセージがスレッドのメッセージキューにポストされた場合)、戻り値は 0 以外になります。

メッセージが WM_KEYDOWN、WM_KEYUP、WM_SYSKEYDOWN、または WM_SYSKEYUP の場合、変換の有無にかかわらず戻り値は 0 以外になります。

メッセージが変換されなかった場合(つまり文字メッセージがスレッドのメッセージキューにポストされなかった場合)、戻り値は 0 になります。

解説(Remarks)

TranslateMessage 関数は、lpMsg パラメーターが指すメッセージを変更しません。

WM_KEYDOWN と WM_KEYUP の組み合わせは、WM_CHAR または WM_DEADCHAR メッセージを生成します。WM_SYSKEYDOWN と WM_SYSKEYUP の組み合わせは、WM_SYSCHAR または WM_SYSDEADCHAR メッセージを生成します。

TranslateMessage は、キーボードドライバーによって ASCII 文字にマップされるキーに対してのみ WM_CHAR メッセージを生成します。

アプリケーションが仮想キーメッセージを他の目的で処理する場合は、TranslateMessage を呼び出すべきではありません。たとえば、TranslateAccelerator 関数が 0 以外の値を返した場合、アプリケーションは TranslateMessage を呼び出すべきではありません。なお、入力メッセージの取得とダイアログボックスへのディスパッチはアプリケーションの責任です。ほとんどのアプリケーションはこのためにメインメッセージループを使用します。ただし、ユーザーがキーボードを使用してコントロール間を移動したり選択したりできるようにするには、アプリケーションは IsDialogMessage を呼び出す必要があります。詳細については、ダイアログボックスのキーボードインターフェイスを参照してください。

例

例については、メッセージループの作成を参照してください。

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

各言語での呼び出し定義

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

BOOL TranslateMessage(
    const MSG* lpMsg
);

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

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

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

import ctypes
from ctypes import wintypes

TranslateMessage = ctypes.windll.user32.TranslateMessage
TranslateMessage.restype = wintypes.BOOL
TranslateMessage.argtypes = [
    ctypes.c_void_p,  # lpMsg : MSG*
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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