Win32 API 日本語リファレンス
ホームUI.Input.KeyboardAndMouse › VkKeyScanA

VkKeyScanA

関数
文字を対応する仮想キーとシフト状態に変換する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

SHORT VkKeyScanA(
    CHAR ch
);

パラメーター

名前方向説明
chCHARin仮想キーコードに変換する文字。

戻り値の型: SHORT

公式ドキュメント

文字を、現在のキーボードに対応する仮想キーコードおよびシフト状態に変換します。(ANSI)

戻り値

型: SHORT

関数が成功した場合、戻り値の下位バイトには仮想キーコードが、上位バイトにはシフト状態が格納されます。シフト状態は次のフラグビットの組み合わせになります。

戻り値 説明
1
いずれかの SHIFT キーが押されています。
2
いずれかの CTRL キーが押されています。
4
いずれかの ALT キーが押されています。
8
半角キーが押されています。
16
予約済み(キーボードレイアウトドライバーによって定義されます)。
32
予約済み(キーボードレイアウトドライバーによって定義されます)。

渡された文字コードに変換できるキーが見つからない場合、下位バイトと上位バイトの両方に –1 が格納されます。

解説(Remarks)

右側の ALT キーをシフトキーとして使用するキーボードレイアウト(例: フランス語キーボードレイアウト)では、右側の ALT キーが内部的に CTRL+ALT に変換されるため、シフト状態は値 6 で表されます。

数値キーパッド(VK_NUMPAD0 から VK_DIVIDE まで)の変換は無視されます。この関数は、メインキーボード部分の文字のみをキー操作に変換することを目的としています。たとえば、文字「7」は VK_NUMPAD7 ではなく VK_7 に変換されます。

VkKeyScan は、WM_KEYUP および WM_KEYDOWN メッセージを使用して文字を送信するアプリケーションで使用されます。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして VkKeyScan を定義しています。このエンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

SHORT VkKeyScanA(
    CHAR ch
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short VkKeyScanA(
    sbyte ch   // CHAR
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function VkKeyScanA(
    ch As SByte   ' CHAR
) As Short
End Function
' ch : CHAR
Declare PtrSafe Function VkKeyScanA Lib "user32" ( _
    ByVal ch As Byte) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

VkKeyScanA = ctypes.windll.user32.VkKeyScanA
VkKeyScanA.restype = ctypes.c_short
VkKeyScanA.argtypes = [
    ctypes.c_byte,  # ch : CHAR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
VkKeyScanA = Fiddle::Function.new(
  lib['VkKeyScanA'],
  [
    Fiddle::TYPE_CHAR,  # ch : CHAR
  ],
  Fiddle::TYPE_SHORT)
#[link(name = "user32")]
extern "system" {
    fn VkKeyScanA(
        ch: i8  // CHAR
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi)]
public static extern short VkKeyScanA(sbyte ch);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_VkKeyScanA' -Namespace Win32 -PassThru
# $api::VkKeyScanA(ch)
#uselib "USER32.dll"
#func global VkKeyScanA "VkKeyScanA" sptr
; VkKeyScanA ch   ; 戻り値は stat
; ch : CHAR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global VkKeyScanA "VkKeyScanA" int
; res = VkKeyScanA(ch)
; ch : CHAR -> "int"
; SHORT VkKeyScanA(CHAR ch)
#uselib "USER32.dll"
#cfunc global VkKeyScanA "VkKeyScanA" int
; res = VkKeyScanA(ch)
; ch : CHAR -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procVkKeyScanA = user32.NewProc("VkKeyScanA")
)

// ch (CHAR)
r1, _, err := procVkKeyScanA.Call(
	uintptr(ch),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // SHORT
function VkKeyScanA(
  ch: Shortint   // CHAR
): Smallint; stdcall;
  external 'USER32.dll' name 'VkKeyScanA';
result := DllCall("USER32\VkKeyScanA"
    , "Char", ch   ; CHAR
    , "Short")   ; return: SHORT
●VkKeyScanA(ch) = DLL("USER32.dll", "int VkKeyScanA(char)")
# 呼び出し: VkKeyScanA(ch)
# ch : CHAR -> "char"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn VkKeyScanA(
    ch: i8 // CHAR
) callconv(std.os.windows.WINAPI) i16;
proc VkKeyScanA(
    ch: int8  # CHAR
): int16 {.importc: "VkKeyScanA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
short VkKeyScanA(
    byte ch   // CHAR
);
ccall((:VkKeyScanA, "USER32.dll"), stdcall, Int16,
      (Int8,),
      ch)
# ch : CHAR -> Int8
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int16_t VkKeyScanA(
    int8_t ch);
]]
local user32 = ffi.load("user32")
-- user32.VkKeyScanA(ch)
-- ch : CHAR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const VkKeyScanA = lib.func('__stdcall', 'VkKeyScanA', 'int16_t', ['int8_t']);
// VkKeyScanA(ch)
// ch : CHAR -> 'int8_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  VkKeyScanA: { parameters: ["i8"], result: "i16" },
});
// lib.symbols.VkKeyScanA(ch)
// ch : CHAR -> "i8"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int16_t VkKeyScanA(
    int8_t ch);
C, "USER32.dll");
// $ffi->VkKeyScanA(ch);
// ch : CHAR
// 構造体/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 VkKeyScanA(
        byte ch   // CHAR
    );
}
@[Link("user32")]
lib LibUSER32
  fun VkKeyScanA = VkKeyScanA(
    ch : Int8   # CHAR
  ) : Int16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef VkKeyScanANative = Int16 Function(Int8);
typedef VkKeyScanADart = int Function(int);
final VkKeyScanA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<VkKeyScanANative, VkKeyScanADart>('VkKeyScanA');
// ch : CHAR -> Int8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function VkKeyScanA(
  ch: Shortint   // CHAR
): Smallint; stdcall;
  external 'USER32.dll' name 'VkKeyScanA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "VkKeyScanA"
  c_VkKeyScanA :: Int8 -> IO Int16
-- ch : CHAR -> Int8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let vkkeyscana =
  foreign "VkKeyScanA"
    (int8_t @-> returning int16_t)
(* ch : CHAR -> int8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("VkKeyScanA" vk-key-scan-a :convention :stdcall) :int16
  (ch :int8))   ; CHAR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $VkKeyScanA = Win32::API::More->new('USER32',
    'short VkKeyScanA(char ch)');
# my $ret = $VkKeyScanA->Call($ch);
# ch : CHAR -> char
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目