ホーム › UI.Input.KeyboardAndMouse › ToUnicode

ToUnicode

関数

仮想キーとキー状態をUnicode文字に変換する。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
wVirtKey	DWORD	in	変換する仮想キーコード。Virtual-Key Codes を参照してください。
wScanCode	DWORD	in	変換するキーのハードウェアスキャンコード。この値の最上位ビットは、キーが離されている場合にセットされます。
lpKeyState	BYTE*	inoptional	現在のキーボードの状態を格納した 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+テンキーのキーの組み合わせは処理されません。ビット 2 がセットされている場合、キーボードの状態は変更されません (Windows 10 バージョン 1607 以降)。その他のすべてのビット (31 まで) は予約済みです。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

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

解説(Remarks)

指定したコードの変換に使用するキーボードレイアウトのハンドルを指定するには、ToUnicodeEx 関数を使用します。

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

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

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

ToUnicode は仮想キーコードを変換する際に、カーネルモードのキーボードバッファーの状態も変更します。この状態変更は、デッドキー、合字、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 ToUnicode(
    DWORD wVirtKey,
    DWORD wScanCode,
    const BYTE* lpKeyState,   // optional
    LPWSTR pwszBuff,
    INT cchBuff,
    DWORD wFlags
);

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

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

' wVirtKey : DWORD
' wScanCode : DWORD
' lpKeyState : BYTE* optional
' pwszBuff : LPWSTR out
' cchBuff : INT
' wFlags : DWORD
Declare PtrSafe Function ToUnicode 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) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "user32")]
extern "system" {
    fn ToUnicode(
        wVirtKey: u32,  // DWORD
        wScanCode: u32,  // DWORD
        lpKeyState: *const u8,  // BYTE* optional
        pwszBuff: *mut u16,  // LPWSTR out
        cchBuff: i32,  // INT
        wFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern int ToUnicode(uint wVirtKey, uint wScanCode, IntPtr lpKeyState, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszBuff, int cchBuff, uint wFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ToUnicode' -Namespace Win32 -PassThru
# $api::ToUnicode(wVirtKey, wScanCode, lpKeyState, pwszBuff, cchBuff, wFlags)

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

出力引数:

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