Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
wVirtKeyDWORDin
wScanCodeDWORDin
lpKeyStateBYTE*in
pwszBuffLPWSTRout
cchBuffINTin
wFlagsDWORDin
dwhklHKLinoptional

戻り値の型: INT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; INT ToUnicodeEx(DWORD wVirtKey, DWORD wScanCode, BYTE* lpKeyState, LPWSTR pwszBuff, INT cchBuff, DWORD wFlags, HKL dwhkl)
#uselib "USER32.dll"
#cfunc global ToUnicodeEx "ToUnicodeEx" int, int, var, var, int, int, intptr
; 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 -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procToUnicodeEx = user32.NewProc("ToUnicodeEx")
)

// wVirtKey (DWORD), wScanCode (DWORD), lpKeyState (BYTE*), pwszBuff (LPWSTR out), cchBuff (INT), wFlags (DWORD), dwhkl (HKL optional)
r1, _, err := procToUnicodeEx.Call(
	uintptr(wVirtKey),
	uintptr(wScanCode),
	uintptr(lpKeyState),
	uintptr(pwszBuff),
	uintptr(cchBuff),
	uintptr(wFlags),
	uintptr(dwhkl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function ToUnicodeEx(
  wVirtKey: DWORD;   // DWORD
  wScanCode: DWORD;   // DWORD
  lpKeyState: Pointer;   // BYTE*
  pwszBuff: PWideChar;   // LPWSTR out
  cchBuff: Integer;   // INT
  wFlags: DWORD;   // DWORD
  dwhkl: THandle   // HKL optional
): Integer; stdcall;
  external 'USER32.dll' name 'ToUnicodeEx';
result := DllCall("USER32\ToUnicodeEx"
    , "UInt", wVirtKey   ; DWORD
    , "UInt", wScanCode   ; DWORD
    , "Ptr", lpKeyState   ; BYTE*
    , "Ptr", pwszBuff   ; LPWSTR out
    , "Int", cchBuff   ; INT
    , "UInt", wFlags   ; DWORD
    , "Ptr", dwhkl   ; HKL optional
    , "Int")   ; return: INT
●ToUnicodeEx(wVirtKey, wScanCode, lpKeyState, pwszBuff, cchBuff, wFlags, dwhkl) = DLL("USER32.dll", "int ToUnicodeEx(dword, dword, void*, char*, int, dword, void*)")
# 呼び出し: ToUnicodeEx(wVirtKey, wScanCode, lpKeyState, pwszBuff, cchBuff, wFlags, dwhkl)
# wVirtKey : DWORD -> "dword"
# wScanCode : DWORD -> "dword"
# lpKeyState : BYTE* -> "void*"
# pwszBuff : LPWSTR out -> "char*"
# cchBuff : INT -> "int"
# wFlags : DWORD -> "dword"
# dwhkl : HKL optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。