VkKeyScanExW
関数シグネチャ
// USER32.dll (Unicode / -W)
#include <windows.h>
SHORT VkKeyScanExW(
WCHAR ch,
HKL dwhkl
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| ch | WCHAR | in | 仮想キーコードに変換する文字。 |
| dwhkl | HKL | in | 文字の変換に使用する入力ロケール識別子。このパラメーターには、LoadKeyboardLayout 関数が以前に返した任意の入力ロケール識別子を指定できます。 |
戻り値の型: SHORT
公式ドキュメント
文字を、対応する仮想キーコードとシフト状態に変換します。この関数は、入力ロケール識別子で指定された入力言語と物理キーボードレイアウトを使用して文字を変換します。(Unicode)
戻り値
型: SHORT
関数が成功した場合、戻り値の下位バイトには仮想キーコードが、上位バイトにはシフト状態が格納されます。シフト状態は、次のフラグビットの組み合わせになります。
| 戻り値 | 説明 |
|---|---|
|
いずれかの SHIFT キーが押されています。 |
|
いずれかの CTRL キーが押されています。 |
|
いずれかの ALT キーが押されています。 |
|
半角キーが押されています。 |
|
予約済み(キーボードレイアウトドライバーによって定義されます)。 |
|
予約済み(キーボードレイアウトドライバーによって定義されます)。 |
渡された文字コードに変換されるキーが見つからない場合、下位バイトと上位バイトの両方に –1 が格納されます。
解説(Remarks)
入力ロケール識別子はキーボードレイアウトよりも広い概念であり、音声テキスト変換ツール、Input Method Editor (IME)、その他あらゆる形式の入力も含み得ます。
右側の ALT キーをシフトキーとして使用するキーボードレイアウト(例: フランス語キーボードレイアウト)の場合、右側の ALT キーは内部的に CTRL+ALT に変換されるため、シフト状態は値 6 で表されます。
テンキー(VK_NUMPAD0 から VK_DIVIDE まで)の変換は無視されます。この関数は、メインキーボード部分のみから文字をキーストロークに変換することを目的としています。たとえば、文字「7」は VK_NUMPAD7 ではなく VK_7 に変換されます。
VkKeyScanEx は、 WM_KEYUP および WM_KEYDOWN メッセージを使用して文字を送信するアプリケーションで使われます。
winuser.h ヘッダーは VkKeyScanEx をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立なエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (Unicode / -W)
#include <windows.h>
SHORT VkKeyScanExW(
WCHAR ch,
HKL dwhkl
);[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern short VkKeyScanExW(
char ch, // WCHAR
IntPtr dwhkl // HKL
);<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function VkKeyScanExW(
ch As Char, ' WCHAR
dwhkl As IntPtr ' HKL
) As Short
End Function' ch : WCHAR
' dwhkl : HKL
Declare PtrSafe Function VkKeyScanExW Lib "user32" ( _
ByVal ch As Integer, _
ByVal dwhkl As LongPtr) As Integer
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
VkKeyScanExW = ctypes.windll.user32.VkKeyScanExW
VkKeyScanExW.restype = ctypes.c_short
VkKeyScanExW.argtypes = [
ctypes.c_wchar, # ch : WCHAR
wintypes.HANDLE, # dwhkl : HKL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
VkKeyScanExW = Fiddle::Function.new(
lib['VkKeyScanExW'],
[
Fiddle::TYPE_SHORT, # ch : WCHAR
Fiddle::TYPE_VOIDP, # dwhkl : HKL
],
Fiddle::TYPE_SHORT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "user32")]
extern "system" {
fn VkKeyScanExW(
ch: u16, // WCHAR
dwhkl: *mut core::ffi::c_void // HKL
) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern short VkKeyScanExW(char ch, IntPtr dwhkl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_VkKeyScanExW' -Namespace Win32 -PassThru
# $api::VkKeyScanExW(ch, dwhkl)#uselib "USER32.dll"
#func global VkKeyScanExW "VkKeyScanExW" wptr, wptr
; VkKeyScanExW ch, dwhkl ; 戻り値は stat
; ch : WCHAR -> "wptr"
; dwhkl : HKL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global VkKeyScanExW "VkKeyScanExW" int, sptr
; res = VkKeyScanExW(ch, dwhkl)
; ch : WCHAR -> "int"
; dwhkl : HKL -> "sptr"; SHORT VkKeyScanExW(WCHAR ch, HKL dwhkl)
#uselib "USER32.dll"
#cfunc global VkKeyScanExW "VkKeyScanExW" int, intptr
; res = VkKeyScanExW(ch, dwhkl)
; ch : WCHAR -> "int"
; dwhkl : HKL -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procVkKeyScanExW = user32.NewProc("VkKeyScanExW")
)
// ch (WCHAR), dwhkl (HKL)
r1, _, err := procVkKeyScanExW.Call(
uintptr(ch),
uintptr(dwhkl),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SHORTfunction VkKeyScanExW(
ch: WideChar; // WCHAR
dwhkl: THandle // HKL
): Smallint; stdcall;
external 'USER32.dll' name 'VkKeyScanExW';result := DllCall("USER32\VkKeyScanExW"
, "Short", ch ; WCHAR
, "Ptr", dwhkl ; HKL
, "Short") ; return: SHORT●VkKeyScanExW(ch, dwhkl) = DLL("USER32.dll", "int VkKeyScanExW(int, void*)")
# 呼び出し: VkKeyScanExW(ch, dwhkl)
# ch : WCHAR -> "int"
# dwhkl : HKL -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "user32" fn VkKeyScanExW(
ch: u16, // WCHAR
dwhkl: ?*anyopaque // HKL
) callconv(std.os.windows.WINAPI) i16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc VkKeyScanExW(
ch: uint16, # WCHAR
dwhkl: pointer # HKL
): int16 {.importc: "VkKeyScanExW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "user32");
extern(Windows)
short VkKeyScanExW(
wchar ch, // WCHAR
void* dwhkl // HKL
);ccall((:VkKeyScanExW, "USER32.dll"), stdcall, Int16,
(UInt16, Ptr{Cvoid}),
ch, dwhkl)
# ch : WCHAR -> UInt16
# dwhkl : HKL -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int16_t VkKeyScanExW(
uint16_t ch,
void* dwhkl);
]]
local user32 = ffi.load("user32")
-- user32.VkKeyScanExW(ch, dwhkl)
-- ch : WCHAR
-- dwhkl : HKL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const VkKeyScanExW = lib.func('__stdcall', 'VkKeyScanExW', 'int16_t', ['uint16_t', 'void *']);
// VkKeyScanExW(ch, dwhkl)
// ch : WCHAR -> 'uint16_t'
// dwhkl : HKL -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
VkKeyScanExW: { parameters: ["u16", "pointer"], result: "i16" },
});
// lib.symbols.VkKeyScanExW(ch, dwhkl)
// ch : WCHAR -> "u16"
// dwhkl : HKL -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int16_t VkKeyScanExW(
uint16_t ch,
void* dwhkl);
C, "USER32.dll");
// $ffi->VkKeyScanExW(ch, dwhkl);
// ch : WCHAR
// dwhkl : HKL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface User32 extends StdCallLibrary {
User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.UNICODE_OPTIONS);
short VkKeyScanExW(
char ch, // WCHAR
Pointer dwhkl // HKL
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("user32")]
lib LibUSER32
fun VkKeyScanExW = VkKeyScanExW(
ch : UInt16, # WCHAR
dwhkl : Void* # HKL
) : Int16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef VkKeyScanExWNative = Int16 Function(Uint16, Pointer<Void>);
typedef VkKeyScanExWDart = int Function(int, Pointer<Void>);
final VkKeyScanExW = DynamicLibrary.open('USER32.dll')
.lookupFunction<VkKeyScanExWNative, VkKeyScanExWDart>('VkKeyScanExW');
// ch : WCHAR -> Uint16
// dwhkl : HKL -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function VkKeyScanExW(
ch: WideChar; // WCHAR
dwhkl: THandle // HKL
): Smallint; stdcall;
external 'USER32.dll' name 'VkKeyScanExW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "VkKeyScanExW"
c_VkKeyScanExW :: Word16 -> Ptr () -> IO Int16
-- ch : WCHAR -> Word16
-- dwhkl : HKL -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let vkkeyscanexw =
foreign "VkKeyScanExW"
(uint16_t @-> (ptr void) @-> returning int16_t)
(* ch : WCHAR -> uint16_t *)
(* dwhkl : HKL -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("VkKeyScanExW" vk-key-scan-ex-w :convention :stdcall) :int16
(ch :uint16) ; WCHAR
(dwhkl :pointer)) ; HKL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $VkKeyScanExW = Win32::API::More->new('USER32',
'short VkKeyScanExW(WORD ch, HANDLE dwhkl)');
# my $ret = $VkKeyScanExW->Call($ch, $dwhkl);
# ch : WCHAR -> WORD
# dwhkl : HKL -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f VkKeyScanExA (ANSI版) — 文字を仮想キーとシフト状態に変換する(ANSI・レイアウト指定版)。
- f VkKeyScanW — 文字を対応する仮想キーとシフト状態に変換する(Unicode版)。
- f GetAsyncKeyState — 呼び出し時点のキーの押下状態を非同期に取得する。
- f GetKeyNameTextW — スキャンコードに対応するキー名の文字列を取得する(Unicode版)。
- f GetKeyState — 指定した仮想キーの押下・トグル状態を取得する。
- f GetKeyboardState — 全仮想キーの状態を配列としてまとめて取得する。
- f LoadKeyboardLayoutW — キーボードレイアウトを読み込んで有効化する(Unicode版)。
- f SetKeyboardState — 全仮想キーの状態を配列でまとめて設定する。
- f ToAsciiEx — 仮想キーとキー状態をASCII文字に変換する(レイアウト指定版)。