ホーム › UI.Input.KeyboardAndMouse › ToUnicodeEx

ToUnicodeEx

関数

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

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

シグネチャ

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

INT ToUnicodeEx(
    DWORD wVirtKey,
    DWORD wScanCode,
    const BYTE* lpKeyState,
    LPWSTR pwszBuff,
    INT cchBuff,
    DWORD wFlags,
    HKL dwhkl   // optional
);

パラメーター

名前	型	方向	説明
wVirtKey	DWORD	in	変換する仮想キーコード。Virtual-Key Codes を参照してください。
wScanCode	DWORD	in	変換するキーのハードウェアスキャンコード。キーが離されている場合、この値の最上位ビットが設定されます。
lpKeyState	BYTE*	in	現在のキーボード状態を格納する 256 バイトの配列へのポインター。配列の各要素(バイト)は 1 つのキーの状態を表します。バイトの最上位ビットが設定されている場合、そのキーは押されています。最下位ビットが設定されている場合、そのキーがトグルでオンになっていることを示します。この関数では、CAPS LOCK キーのトグルビットのみが意味を持ちます。NUM LOCK および SCROLL LOCK キーのトグル状態は無視されます。詳細については GetKeyboardState を参照してください。
pwszBuff	LPWSTR	out	変換された文字を UTF-16 コードユニットの配列として受け取るバッファー。変数名は null 終端を示唆していますが、このバッファーは null 終端されずに返される場合があります。書き込まれた文字数を判別するには、このメソッドの戻り値を使用できます。
cchBuff	INT	in	pwszBuff パラメーターが指すバッファーのサイズ(文字数)。
wFlags	DWORD	in	関数の動作。ビット 0 が設定されている場合、メニューがアクティブです。このモードでは、Alt+テンキーのキーの組み合わせは処理されません。ビット 1 が設定されている場合、ToUnicodeEx は通常のキー押下(make)イベントの処理に加えて、キー離し(break)イベントとしてマークされたスキャンコードも変換します。ビット 2 が設定されている場合、キーボード状態は変更されません(Windows 10 バージョン 1607 以降)。その他のすべてのビット(31 まで)は予約されています。
dwhkl	HKL	inoptional	指定されたコードを変換するために使用する入力ロケール識別子。このパラメーターには、LoadKeyboardLayout 関数によって以前に返された任意の入力ロケール識別子を指定できます。

戻り値の型: INT

公式ドキュメント

指定された仮想キーコードとキーボード状態を、対応する Unicode 文字(複数の場合あり)に変換します。(ToUnicodeEx)

戻り値

型: int

この関数は次のいずれかの値を返します。

戻り値	説明
value 0	指定された仮想キーはデッドキー文字(アクセント記号または発音区別符号)です。この値は、キーボードレイアウトに関係なく、複数の文字が入力されてキーボード状態に格納されている場合でも返されます。可能であれば、Unicode キーボードレイアウトであっても、関数は pwszBuff で指定されたバッファーにデッドキー文字のスペーシング版を書き込みます。たとえば、関数は COMBINING ACUTE ACCENT 文字(U+0301)ではなく、ACUTE ACCENT 文字(U+00B4)を書き込みます。
0	指定された仮想キーには、現在のキーボード状態に対する変換がありません。pwszBuff で指定されたバッファーには何も書き込まれませんでした。
value > 0	1 つ以上の UTF-16 コードユニットが pwszBuff で指定されたバッファーに書き込まれました。返された pwszBuff には、戻り値が示すより多くの文字が含まれている場合があります。この場合、余分な文字は無効であり、無視してください。

解説(Remarks)

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

一部のキーボードレイアウトでは、複数の文字や、サロゲートペアとしての補助文字が pwszBuff に返される場合があります。キーボードレイアウトに格納されているデッドキー文字(アクセント記号または発音区別符号)を、指定された仮想キーと組み合わせて 1 つの文字を形成できなかった場合、以前に入力されたデッドキー文字を現在の文字と組み合わせることができます。

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

通常、ToUnicodeEx は仮想キーコードに基づいて変換を行います。ただし、場合によっては、wScanCode パラメーターのビット 15 を使用して、キーの押下と離しを区別できます(たとえば ALT+テンキーによる入力の場合)。

ToUnicodeEx は仮想キーコードを変換する際に、カーネルモードのキーボードバッファーの状態も変更します。この状態変更は、デッドキー、合字、Alt+テンキーによるキー入力などに影響します。また、TranslateMessage(これもカーネルモードのキーボードバッファーの状態を変更します)と併用した場合、望ましくない副作用を引き起こす可能性があります。

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

各言語での呼び出し定義

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

INT ToUnicodeEx(
    DWORD wVirtKey,
    DWORD wScanCode,
    const BYTE* lpKeyState,
    LPWSTR pwszBuff,
    INT cchBuff,
    DWORD wFlags,
    HKL dwhkl   // optional
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern int ToUnicodeEx(
    uint wVirtKey,   // DWORD
    uint wScanCode,   // DWORD
    IntPtr lpKeyState,   // BYTE*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszBuff,   // LPWSTR out
    int cchBuff,   // INT
    uint wFlags,   // DWORD
    IntPtr dwhkl   // HKL optional
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function ToUnicodeEx(
    wVirtKey As UInteger,   ' DWORD
    wScanCode As UInteger,   ' DWORD
    lpKeyState As IntPtr,   ' BYTE*
    <MarshalAs(UnmanagedType.LPWStr)> pwszBuff As System.Text.StringBuilder,   ' LPWSTR out
    cchBuff As Integer,   ' INT
    wFlags As UInteger,   ' DWORD
    dwhkl As IntPtr   ' HKL optional
) As Integer
End Function

' wVirtKey : DWORD
' wScanCode : DWORD
' lpKeyState : BYTE*
' pwszBuff : LPWSTR out
' cchBuff : INT
' wFlags : DWORD
' dwhkl : HKL optional
Declare PtrSafe Function ToUnicodeEx Lib "user32" ( _
    ByVal wVirtKey As Long, _
    ByVal wScanCode As Long, _
    ByVal lpKeyState As LongPtr, _
    ByVal pwszBuff As LongPtr, _
    ByVal cchBuff As Long, _
    ByVal wFlags 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

ToUnicodeEx = ctypes.windll.user32.ToUnicodeEx
ToUnicodeEx.restype = ctypes.c_int
ToUnicodeEx.argtypes = [
    wintypes.DWORD,  # wVirtKey : DWORD
    wintypes.DWORD,  # wScanCode : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # lpKeyState : BYTE*
    wintypes.LPWSTR,  # pwszBuff : LPWSTR out
    ctypes.c_int,  # cchBuff : INT
    wintypes.DWORD,  # wFlags : DWORD
    wintypes.HANDLE,  # dwhkl : HKL optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ToUnicodeEx = Fiddle::Function.new(
  lib['ToUnicodeEx'],
  [
    -Fiddle::TYPE_INT,  # wVirtKey : DWORD
    -Fiddle::TYPE_INT,  # wScanCode : DWORD
    Fiddle::TYPE_VOIDP,  # lpKeyState : BYTE*
    Fiddle::TYPE_VOIDP,  # pwszBuff : LPWSTR out
    Fiddle::TYPE_INT,  # cchBuff : INT
    -Fiddle::TYPE_INT,  # wFlags : DWORD
    Fiddle::TYPE_VOIDP,  # dwhkl : HKL optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn ToUnicodeEx(
        wVirtKey: u32,  // DWORD
        wScanCode: u32,  // DWORD
        lpKeyState: *const u8,  // BYTE*
        pwszBuff: *mut u16,  // LPWSTR out
        cchBuff: i32,  // INT
        wFlags: 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 ToUnicodeEx(uint wVirtKey, uint wScanCode, IntPtr lpKeyState, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszBuff, int cchBuff, uint wFlags, IntPtr dwhkl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ToUnicodeEx' -Namespace Win32 -PassThru
# $api::ToUnicodeEx(wVirtKey, wScanCode, lpKeyState, pwszBuff, cchBuff, wFlags, dwhkl)

#uselib "USER32.dll"
#func global ToUnicodeEx "ToUnicodeEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ToUnicodeEx wVirtKey, wScanCode, varptr(lpKeyState), varptr(pwszBuff), cchBuff, wFlags, dwhkl   ; 戻り値は stat
; wVirtKey : DWORD -> "sptr"
; wScanCode : DWORD -> "sptr"
; lpKeyState : BYTE* -> "sptr"
; pwszBuff : LPWSTR out -> "sptr"
; cchBuff : INT -> "sptr"
; wFlags : DWORD -> "sptr"
; dwhkl : HKL optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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