VkKeyScanExA
関数シグネチャ
// USER32.dll (ANSI / -A)
#include <windows.h>
SHORT VkKeyScanExA(
CHAR ch,
HKL dwhkl
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| ch | CHAR | in | 仮想キーコードに変換する文字。 |
| dwhkl | HKL | in | 文字の変換に使用する入力ロケール識別子。このパラメーターには、LoadKeyboardLayout 関数によって以前に返された任意の入力ロケール識別子を指定できます。 |
戻り値の型: SHORT
公式ドキュメント
文字を、対応する仮想キーコードとシフト状態に変換します。この関数は、入力ロケール識別子で指定された入力言語および物理キーボードレイアウトを使用して文字を変換します。(ANSI)
戻り値
型: 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 (ANSI / -A)
#include <windows.h>
SHORT VkKeyScanExA(
CHAR ch,
HKL dwhkl
);[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short VkKeyScanExA(
sbyte ch, // CHAR
IntPtr dwhkl // HKL
);<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function VkKeyScanExA(
ch As SByte, ' CHAR
dwhkl As IntPtr ' HKL
) As Short
End Function' ch : CHAR
' dwhkl : HKL
Declare PtrSafe Function VkKeyScanExA Lib "user32" ( _
ByVal ch As Byte, _
ByVal dwhkl As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
VkKeyScanExA = ctypes.windll.user32.VkKeyScanExA
VkKeyScanExA.restype = ctypes.c_short
VkKeyScanExA.argtypes = [
ctypes.c_byte, # ch : CHAR
wintypes.HANDLE, # dwhkl : HKL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
VkKeyScanExA = Fiddle::Function.new(
lib['VkKeyScanExA'],
[
Fiddle::TYPE_CHAR, # ch : CHAR
Fiddle::TYPE_VOIDP, # dwhkl : HKL
],
Fiddle::TYPE_SHORT)#[link(name = "user32")]
extern "system" {
fn VkKeyScanExA(
ch: i8, // CHAR
dwhkl: *mut core::ffi::c_void // HKL
) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern short VkKeyScanExA(sbyte ch, IntPtr dwhkl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_VkKeyScanExA' -Namespace Win32 -PassThru
# $api::VkKeyScanExA(ch, dwhkl)#uselib "USER32.dll"
#func global VkKeyScanExA "VkKeyScanExA" sptr, sptr
; VkKeyScanExA ch, dwhkl ; 戻り値は stat
; ch : CHAR -> "sptr"
; dwhkl : HKL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global VkKeyScanExA "VkKeyScanExA" int, sptr
; res = VkKeyScanExA(ch, dwhkl)
; ch : CHAR -> "int"
; dwhkl : HKL -> "sptr"; SHORT VkKeyScanExA(CHAR ch, HKL dwhkl)
#uselib "USER32.dll"
#cfunc global VkKeyScanExA "VkKeyScanExA" int, intptr
; res = VkKeyScanExA(ch, dwhkl)
; ch : CHAR -> "int"
; dwhkl : HKL -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procVkKeyScanExA = user32.NewProc("VkKeyScanExA")
)
// ch (CHAR), dwhkl (HKL)
r1, _, err := procVkKeyScanExA.Call(
uintptr(ch),
uintptr(dwhkl),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // SHORTfunction VkKeyScanExA(
ch: Shortint; // CHAR
dwhkl: THandle // HKL
): Smallint; stdcall;
external 'USER32.dll' name 'VkKeyScanExA';result := DllCall("USER32\VkKeyScanExA"
, "Char", ch ; CHAR
, "Ptr", dwhkl ; HKL
, "Short") ; return: SHORT●VkKeyScanExA(ch, dwhkl) = DLL("USER32.dll", "int VkKeyScanExA(char, void*)")
# 呼び出し: VkKeyScanExA(ch, dwhkl)
# ch : CHAR -> "char"
# dwhkl : HKL -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn VkKeyScanExA(
ch: i8, // CHAR
dwhkl: ?*anyopaque // HKL
) callconv(std.os.windows.WINAPI) i16;proc VkKeyScanExA(
ch: int8, # CHAR
dwhkl: pointer # HKL
): int16 {.importc: "VkKeyScanExA", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
short VkKeyScanExA(
byte ch, // CHAR
void* dwhkl // HKL
);ccall((:VkKeyScanExA, "USER32.dll"), stdcall, Int16,
(Int8, Ptr{Cvoid}),
ch, dwhkl)
# ch : CHAR -> Int8
# dwhkl : HKL -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int16_t VkKeyScanExA(
int8_t ch,
void* dwhkl);
]]
local user32 = ffi.load("user32")
-- user32.VkKeyScanExA(ch, dwhkl)
-- ch : CHAR
-- dwhkl : HKL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const VkKeyScanExA = lib.func('__stdcall', 'VkKeyScanExA', 'int16_t', ['int8_t', 'void *']);
// VkKeyScanExA(ch, dwhkl)
// ch : CHAR -> 'int8_t'
// dwhkl : HKL -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
VkKeyScanExA: { parameters: ["i8", "pointer"], result: "i16" },
});
// lib.symbols.VkKeyScanExA(ch, dwhkl)
// ch : CHAR -> "i8"
// dwhkl : HKL -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int16_t VkKeyScanExA(
int8_t ch,
void* dwhkl);
C, "USER32.dll");
// $ffi->VkKeyScanExA(ch, dwhkl);
// ch : CHAR
// 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.ASCII_OPTIONS);
short VkKeyScanExA(
byte ch, // CHAR
Pointer dwhkl // HKL
);
}@[Link("user32")]
lib LibUSER32
fun VkKeyScanExA = VkKeyScanExA(
ch : Int8, # CHAR
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 VkKeyScanExANative = Int16 Function(Int8, Pointer<Void>);
typedef VkKeyScanExADart = int Function(int, Pointer<Void>);
final VkKeyScanExA = DynamicLibrary.open('USER32.dll')
.lookupFunction<VkKeyScanExANative, VkKeyScanExADart>('VkKeyScanExA');
// ch : CHAR -> Int8
// dwhkl : HKL -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function VkKeyScanExA(
ch: Shortint; // CHAR
dwhkl: THandle // HKL
): Smallint; stdcall;
external 'USER32.dll' name 'VkKeyScanExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "VkKeyScanExA"
c_VkKeyScanExA :: Int8 -> Ptr () -> IO Int16
-- ch : CHAR -> Int8
-- dwhkl : HKL -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let vkkeyscanexa =
foreign "VkKeyScanExA"
(int8_t @-> (ptr void) @-> returning int16_t)
(* ch : CHAR -> int8_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 ("VkKeyScanExA" vk-key-scan-ex-a :convention :stdcall) :int16
(ch :int8) ; CHAR
(dwhkl :pointer)) ; HKL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $VkKeyScanExA = Win32::API::More->new('USER32',
'short VkKeyScanExA(char ch, HANDLE dwhkl)');
# my $ret = $VkKeyScanExA->Call($ch, $dwhkl);
# ch : CHAR -> char
# dwhkl : HKL -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f VkKeyScanExW (Unicode版) — 文字を仮想キーとシフト状態に変換する(Unicode・レイアウト指定版)。
- f VkKeyScanA — 文字を対応する仮想キーとシフト状態に変換する(ANSI版)。
- f GetAsyncKeyState — 呼び出し時点のキーの押下状態を非同期に取得する。
- f GetKeyNameTextA — スキャンコードに対応するキー名の文字列を取得する(ANSI版)。
- f GetKeyState — 指定した仮想キーの押下・トグル状態を取得する。
- f GetKeyboardState — 全仮想キーの状態を配列としてまとめて取得する。
- f LoadKeyboardLayoutA — キーボードレイアウトを読み込んで有効化する(ANSI版)。
- f SetKeyboardState — 全仮想キーの状態を配列でまとめて設定する。
- f ToAsciiEx — 仮想キーとキー状態をASCII文字に変換する(レイアウト指定版)。