ホーム › UI.Input.KeyboardAndMouse › ToAsciiEx

ToAsciiEx

関数

仮想キーとキー状態をASCII文字に変換する(レイアウト指定版)。

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

シグネチャ

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

INT ToAsciiEx(
    DWORD uVirtKey,
    DWORD uScanCode,
    const BYTE* lpKeyState,   // optional
    WORD* lpChar,
    DWORD uFlags,
    HKL dwhkl   // optional
);

パラメーター

名前	型	方向	説明
uVirtKey	DWORD	in	変換する仮想キーコード。Virtual-Key Codes を参照してください。
uScanCode	DWORD	in	変換するキーのハードウェアスキャンコード。キーが離されている(押されていない)場合、この値の最上位ビットが設定されます。
lpKeyState	BYTE*	inoptional	現在のキーボードの状態を格納する256バイトの配列へのポインター。配列内の各要素(バイト)は1つのキーの状態を保持します。バイトの最上位ビットが設定されている場合、そのキーは押されています。最下位ビットが設定されている場合は、キーがトグルでオンになっていることを示します。この関数では、CAPS LOCK キーのトグルビットのみが関係します。NUM LOCK および SCROLL LOCK キーのトグル状態は無視されます。
lpChar	WORD*	out	変換された文字を受け取るバッファーへのポインター(または、1つの WORD 値にパックされた2文字。下位バイトに1文字目、上位バイトに2文字目が格納されます)。
uFlags	DWORD	in	メニューがアクティブな場合は 1、そうでない場合は 0 を指定する必要があります。
dwhkl	HKL	inoptional	コードの変換に使用する入力ロケール識別子。このパラメーターには、LoadKeyboardLayout 関数が以前に返した任意の入力ロケール識別子を指定できます。

戻り値の型: INT

公式ドキュメント

指定された仮想キーコードとキーボードの状態を、対応する1文字または複数の文字に変換します。この関数は、入力ロケール識別子で指定された入力言語と物理キーボードレイアウトを使用してコードを変換します。

戻り値

型: int

戻り値は次のいずれかの値です。

戻り値	説明
0	指定された仮想キーには、現在のキーボードの状態に対する変換結果がありません。
1	1文字がバッファーにコピーされました。
2	2文字がバッファーにコピーされました。これは通常、キーボードレイアウトに格納されているデッドキー文字(アクセントまたはダイアクリティカルマーク)を指定された仮想キーと合成して1文字を形成できない場合に発生します。

解説(Remarks)

入力ロケール識別子は、キーボードレイアウトよりも広い概念です。音声テキスト変換、Input Method Editor (IME)、その他あらゆる形式の入力を含む場合があるためです。

以前のデッドキーがキーボードレイアウトに格納されているため、ToAsciiEx 関数に渡されたパラメーターだけでは仮想キーコードを変換するのに十分でない場合があります。

通常、ToAsciiEx は仮想キーコードに基づいて変換を行います。ただし場合によっては、 uScanCode パラメーターのビット15を使用して、キーの押下とキーの解放を区別することがあります。スキャンコードは ALT+数字キーの組み合わせの変換に使用されます。

NUM LOCK はキーボードの動作に影響を与えるトグルキーですが、ToAsciiEx は lpKeyState (VK_NUMLOCK) のトグル設定(最下位ビット)を無視します。 uVirtKey パラメーターだけで、カーソル移動キー(VK_HOME、VK_INSERT など)と数字キー(VK_DECIMAL、VK_NUMPAD0 ～ VK_NUMPAD9)を区別するのに十分だからです。

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

各言語での呼び出し定義

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

INT ToAsciiEx(
    DWORD uVirtKey,
    DWORD uScanCode,
    const BYTE* lpKeyState,   // optional
    WORD* lpChar,
    DWORD uFlags,
    HKL dwhkl   // optional
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern int ToAsciiEx(
    uint uVirtKey,   // DWORD
    uint uScanCode,   // DWORD
    IntPtr lpKeyState,   // BYTE* optional
    out ushort lpChar,   // WORD* out
    uint uFlags,   // DWORD
    IntPtr dwhkl   // HKL optional
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function ToAsciiEx(
    uVirtKey As UInteger,   ' DWORD
    uScanCode As UInteger,   ' DWORD
    lpKeyState As IntPtr,   ' BYTE* optional
    <Out> ByRef lpChar As UShort,   ' WORD* out
    uFlags As UInteger,   ' DWORD
    dwhkl As IntPtr   ' HKL optional
) As Integer
End Function

' uVirtKey : DWORD
' uScanCode : DWORD
' lpKeyState : BYTE* optional
' lpChar : WORD* out
' uFlags : DWORD
' dwhkl : HKL optional
Declare PtrSafe Function ToAsciiEx Lib "user32" ( _
    ByVal uVirtKey As Long, _
    ByVal uScanCode As Long, _
    ByVal lpKeyState As LongPtr, _
    ByRef lpChar As Integer, _
    ByVal uFlags As Long, _
    ByVal dwhkl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ToAsciiEx = ctypes.windll.user32.ToAsciiEx
ToAsciiEx.restype = ctypes.c_int
ToAsciiEx.argtypes = [
    wintypes.DWORD,  # uVirtKey : DWORD
    wintypes.DWORD,  # uScanCode : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # lpKeyState : BYTE* optional
    ctypes.POINTER(ctypes.c_ushort),  # lpChar : WORD* out
    wintypes.DWORD,  # uFlags : DWORD
    wintypes.HANDLE,  # dwhkl : HKL optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ToAsciiEx = Fiddle::Function.new(
  lib['ToAsciiEx'],
  [
    -Fiddle::TYPE_INT,  # uVirtKey : DWORD
    -Fiddle::TYPE_INT,  # uScanCode : DWORD
    Fiddle::TYPE_VOIDP,  # lpKeyState : BYTE* optional
    Fiddle::TYPE_VOIDP,  # lpChar : WORD* out
    -Fiddle::TYPE_INT,  # uFlags : DWORD
    Fiddle::TYPE_VOIDP,  # dwhkl : HKL optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn ToAsciiEx(
        uVirtKey: u32,  // DWORD
        uScanCode: u32,  // DWORD
        lpKeyState: *const u8,  // BYTE* optional
        lpChar: *mut u16,  // WORD* out
        uFlags: u32,  // DWORD
        dwhkl: *mut core::ffi::c_void  // HKL optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern int ToAsciiEx(uint uVirtKey, uint uScanCode, IntPtr lpKeyState, out ushort lpChar, uint uFlags, IntPtr dwhkl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ToAsciiEx' -Namespace Win32 -PassThru
# $api::ToAsciiEx(uVirtKey, uScanCode, lpKeyState, lpChar, uFlags, dwhkl)

#uselib "USER32.dll"
#func global ToAsciiEx "ToAsciiEx" sptr, sptr, sptr, sptr, sptr, sptr
; ToAsciiEx uVirtKey, uScanCode, varptr(lpKeyState), varptr(lpChar), uFlags, dwhkl   ; 戻り値は stat
; uVirtKey : DWORD -> "sptr"
; uScanCode : DWORD -> "sptr"
; lpKeyState : BYTE* optional -> "sptr"
; lpChar : WORD* out -> "sptr"
; uFlags : DWORD -> "sptr"
; dwhkl : HKL optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global ToAsciiEx "ToAsciiEx" int, int, var, var, int, sptr
; res = ToAsciiEx(uVirtKey, uScanCode, lpKeyState, lpChar, uFlags, dwhkl)
; uVirtKey : DWORD -> "int"
; uScanCode : DWORD -> "int"
; lpKeyState : BYTE* optional -> "var"
; lpChar : WORD* out -> "var"
; uFlags : DWORD -> "int"
; dwhkl : HKL optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global ToAsciiEx "ToAsciiEx" int, int, sptr, sptr, int, sptr
; res = ToAsciiEx(uVirtKey, uScanCode, varptr(lpKeyState), varptr(lpChar), uFlags, dwhkl)
; uVirtKey : DWORD -> "int"
; uScanCode : DWORD -> "int"
; lpKeyState : BYTE* optional -> "sptr"
; lpChar : WORD* out -> "sptr"
; uFlags : DWORD -> "int"
; dwhkl : HKL optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。