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

MapVirtualKeyExW

関数
仮想キーとスキャンコードを相互変換する(Unicode・レイアウト指定版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

DWORD MapVirtualKeyExW(
    DWORD uCode,
    MAP_VIRTUAL_KEY_TYPE uMapType,
    HKL dwhkl   // optional
);

パラメーター

名前方向説明
uCodeDWORDinキーの仮想キーコードまたはスキャンコードです。この値がどのように解釈されるかは、uMapType パラメーターの値によって異なります。
uMapTypeMAP_VIRTUAL_KEY_TYPEin

実行する変換の種類です。このパラメーターの値は、uCode パラメーターの値によって異なります。

意味
MAPVK_VK_TO_VSC
0
uCode パラメーターは仮想キーコードであり、スキャンコードに変換されます。左右のキーを区別しない仮想キーコードの場合は、左側のスキャンコードが返されます。変換できない場合、この関数は 0 を返します。
MAPVK_VSC_TO_VK
1
uCode パラメーターはスキャンコードであり、左右のキーを区別しない仮想キーコードに変換されます。変換できない場合、この関数は 0 を返します。
Windows Vista 以降: uCode 値の上位バイトに 0xe0 または 0xe1 を含めることで、拡張スキャンコードを指定できます。
MAPVK_VK_TO_CHAR
2
uCode パラメーターは仮想キーコードであり、戻り値の下位ワードにシフトなしの文字値として変換されます。デッドキー(発音区別符号)は、戻り値の最上位ビットを設定することで示されます。変換できない場合、この関数は 0 を返します。「解説」を参照してください。
MAPVK_VSC_TO_VK_EX
3
uCode パラメーターはスキャンコードであり、左右のキーを区別する仮想キーコードに変換されます。変換できない場合、この関数は 0 を返します。
Windows Vista 以降: uCode 値の上位バイトに 0xe0 または 0xe1 を含めることで、拡張スキャンコードを指定できます。
MAPVK_VK_TO_VSC_EX
4
Windows Vista 以降: uCode パラメーターは仮想キーコードであり、スキャンコードに変換されます。左右のキーを区別しない仮想キーコードの場合は、左側のスキャンコードが返されます。スキャンコードが拡張スキャンコードである場合、戻り値の上位バイトには拡張スキャンコードを指定する 0xe0 または 0xe1 が含まれます。変換できない場合、この関数は 0 を返します。
dwhklHKLinoptional指定したコードの変換に使用する入力ロケール識別子です。このパラメーターには、LoadKeyboardLayout 関数によって以前に返された任意の入力ロケール識別子を指定できます。

戻り値の型: DWORD

公式ドキュメント

仮想キーコードをスキャンコードまたは文字値に変換(マップ)するか、スキャンコードを仮想キーコードに変換します。この関数は、入力言語と入力ロケール識別子を使用してコードを変換します。(Unicode)

戻り値

型: UINT

戻り値は、uCode および uMapType の値に応じて、スキャンコード、仮想キーコード、または文字値のいずれかになります。変換できない場合、戻り値は 0 です。

解説(Remarks)

入力ロケール識別子は、キーボードレイアウトよりも広い概念です。音声テキスト変換器、Input Method Editor (IME)、その他あらゆる形式の入力を包含することができるためです。

アプリケーションは MapVirtualKeyEx を使用して、スキャンコードを仮想キーコード定数 VK_SHIFTVK_CONTROLVK_MENU に変換したり、その逆を行ったりできます。これらの変換では、SHIFT、CTRL、ALT キーの左右のインスタンスは区別されません。

アプリケーションは、uCode に次の仮想キーコード定数のいずれかを設定して MapVirtualKeyEx を呼び出すことで、これらのキーの左側または右側のインスタンスに対応するスキャンコードを取得できます。

これらの左右を区別する定数は、GetKeyboardStateSetKeyboardStateGetAsyncKeyStateGetKeyStateMapVirtualKey、および MapVirtualKeyEx 関数を通じてのみアプリケーションで利用できます。仮想キーコードの完全な一覧については、Virtual Key Codes を参照してください。

MAPVK_VK_TO_CHAR モードでは、仮想キーコードの 'A'..'Z' キーは、現在のキーボードレイアウトに関係なく、大文字の 'A'..'Z' 文字に変換されます。仮想キーコードを対応する文字に変換したい場合は、ToUnicode 関数を使用してください。

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

DWORD MapVirtualKeyExW(
    DWORD uCode,
    MAP_VIRTUAL_KEY_TYPE uMapType,
    HKL dwhkl   // optional
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MapVirtualKeyExW(
    uint uCode,   // DWORD
    uint uMapType,   // MAP_VIRTUAL_KEY_TYPE
    IntPtr dwhkl   // HKL optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MapVirtualKeyExW(
    uCode As UInteger,   ' DWORD
    uMapType As UInteger,   ' MAP_VIRTUAL_KEY_TYPE
    dwhkl As IntPtr   ' HKL optional
) As UInteger
End Function
' uCode : DWORD
' uMapType : MAP_VIRTUAL_KEY_TYPE
' dwhkl : HKL optional
Declare PtrSafe Function MapVirtualKeyExW Lib "user32" ( _
    ByVal uCode As Long, _
    ByVal uMapType As Long, _
    ByVal dwhkl As LongPtr) As Long
' 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

MapVirtualKeyExW = ctypes.windll.user32.MapVirtualKeyExW
MapVirtualKeyExW.restype = wintypes.DWORD
MapVirtualKeyExW.argtypes = [
    wintypes.DWORD,  # uCode : DWORD
    wintypes.DWORD,  # uMapType : MAP_VIRTUAL_KEY_TYPE
    wintypes.HANDLE,  # dwhkl : HKL optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
MapVirtualKeyExW = Fiddle::Function.new(
  lib['MapVirtualKeyExW'],
  [
    -Fiddle::TYPE_INT,  # uCode : DWORD
    -Fiddle::TYPE_INT,  # uMapType : MAP_VIRTUAL_KEY_TYPE
    Fiddle::TYPE_VOIDP,  # dwhkl : HKL optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn MapVirtualKeyExW(
        uCode: u32,  // DWORD
        uMapType: u32,  // MAP_VIRTUAL_KEY_TYPE
        dwhkl: *mut core::ffi::c_void  // HKL optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern uint MapVirtualKeyExW(uint uCode, uint uMapType, IntPtr dwhkl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_MapVirtualKeyExW' -Namespace Win32 -PassThru
# $api::MapVirtualKeyExW(uCode, uMapType, dwhkl)
#uselib "USER32.dll"
#func global MapVirtualKeyExW "MapVirtualKeyExW" wptr, wptr, wptr
; MapVirtualKeyExW uCode, uMapType, dwhkl   ; 戻り値は stat
; uCode : DWORD -> "wptr"
; uMapType : MAP_VIRTUAL_KEY_TYPE -> "wptr"
; dwhkl : HKL optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global MapVirtualKeyExW "MapVirtualKeyExW" int, int, sptr
; res = MapVirtualKeyExW(uCode, uMapType, dwhkl)
; uCode : DWORD -> "int"
; uMapType : MAP_VIRTUAL_KEY_TYPE -> "int"
; dwhkl : HKL optional -> "sptr"
; DWORD MapVirtualKeyExW(DWORD uCode, MAP_VIRTUAL_KEY_TYPE uMapType, HKL dwhkl)
#uselib "USER32.dll"
#cfunc global MapVirtualKeyExW "MapVirtualKeyExW" int, int, intptr
; res = MapVirtualKeyExW(uCode, uMapType, dwhkl)
; uCode : DWORD -> "int"
; uMapType : MAP_VIRTUAL_KEY_TYPE -> "int"
; dwhkl : HKL optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procMapVirtualKeyExW = user32.NewProc("MapVirtualKeyExW")
)

// uCode (DWORD), uMapType (MAP_VIRTUAL_KEY_TYPE), dwhkl (HKL optional)
r1, _, err := procMapVirtualKeyExW.Call(
	uintptr(uCode),
	uintptr(uMapType),
	uintptr(dwhkl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MapVirtualKeyExW(
  uCode: DWORD;   // DWORD
  uMapType: DWORD;   // MAP_VIRTUAL_KEY_TYPE
  dwhkl: THandle   // HKL optional
): DWORD; stdcall;
  external 'USER32.dll' name 'MapVirtualKeyExW';
result := DllCall("USER32\MapVirtualKeyExW"
    , "UInt", uCode   ; DWORD
    , "UInt", uMapType   ; MAP_VIRTUAL_KEY_TYPE
    , "Ptr", dwhkl   ; HKL optional
    , "UInt")   ; return: DWORD
●MapVirtualKeyExW(uCode, uMapType, dwhkl) = DLL("USER32.dll", "dword MapVirtualKeyExW(dword, dword, void*)")
# 呼び出し: MapVirtualKeyExW(uCode, uMapType, dwhkl)
# uCode : DWORD -> "dword"
# uMapType : MAP_VIRTUAL_KEY_TYPE -> "dword"
# dwhkl : HKL optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn MapVirtualKeyExW(
    uCode: u32, // DWORD
    uMapType: u32, // MAP_VIRTUAL_KEY_TYPE
    dwhkl: ?*anyopaque // HKL optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MapVirtualKeyExW(
    uCode: uint32,  # DWORD
    uMapType: uint32,  # MAP_VIRTUAL_KEY_TYPE
    dwhkl: pointer  # HKL optional
): uint32 {.importc: "MapVirtualKeyExW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
uint MapVirtualKeyExW(
    uint uCode,   // DWORD
    uint uMapType,   // MAP_VIRTUAL_KEY_TYPE
    void* dwhkl   // HKL optional
);
ccall((:MapVirtualKeyExW, "USER32.dll"), stdcall, UInt32,
      (UInt32, UInt32, Ptr{Cvoid}),
      uCode, uMapType, dwhkl)
# uCode : DWORD -> UInt32
# uMapType : MAP_VIRTUAL_KEY_TYPE -> UInt32
# dwhkl : HKL optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MapVirtualKeyExW(
    uint32_t uCode,
    uint32_t uMapType,
    void* dwhkl);
]]
local user32 = ffi.load("user32")
-- user32.MapVirtualKeyExW(uCode, uMapType, dwhkl)
-- uCode : DWORD
-- uMapType : MAP_VIRTUAL_KEY_TYPE
-- dwhkl : HKL optional
-- 構造体/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 MapVirtualKeyExW = lib.func('__stdcall', 'MapVirtualKeyExW', 'uint32_t', ['uint32_t', 'uint32_t', 'void *']);
// MapVirtualKeyExW(uCode, uMapType, dwhkl)
// uCode : DWORD -> 'uint32_t'
// uMapType : MAP_VIRTUAL_KEY_TYPE -> 'uint32_t'
// dwhkl : HKL optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  MapVirtualKeyExW: { parameters: ["u32", "u32", "pointer"], result: "u32" },
});
// lib.symbols.MapVirtualKeyExW(uCode, uMapType, dwhkl)
// uCode : DWORD -> "u32"
// uMapType : MAP_VIRTUAL_KEY_TYPE -> "u32"
// dwhkl : HKL optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MapVirtualKeyExW(
    uint32_t uCode,
    uint32_t uMapType,
    void* dwhkl);
C, "USER32.dll");
// $ffi->MapVirtualKeyExW(uCode, uMapType, dwhkl);
// uCode : DWORD
// uMapType : MAP_VIRTUAL_KEY_TYPE
// dwhkl : HKL optional
// 構造体/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);
    int MapVirtualKeyExW(
        int uCode,   // DWORD
        int uMapType,   // MAP_VIRTUAL_KEY_TYPE
        Pointer dwhkl   // HKL optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun MapVirtualKeyExW = MapVirtualKeyExW(
    uCode : UInt32,   # DWORD
    uMapType : UInt32,   # MAP_VIRTUAL_KEY_TYPE
    dwhkl : Void*   # HKL optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MapVirtualKeyExWNative = Uint32 Function(Uint32, Uint32, Pointer<Void>);
typedef MapVirtualKeyExWDart = int Function(int, int, Pointer<Void>);
final MapVirtualKeyExW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<MapVirtualKeyExWNative, MapVirtualKeyExWDart>('MapVirtualKeyExW');
// uCode : DWORD -> Uint32
// uMapType : MAP_VIRTUAL_KEY_TYPE -> Uint32
// dwhkl : HKL optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MapVirtualKeyExW(
  uCode: DWORD;   // DWORD
  uMapType: DWORD;   // MAP_VIRTUAL_KEY_TYPE
  dwhkl: THandle   // HKL optional
): DWORD; stdcall;
  external 'USER32.dll' name 'MapVirtualKeyExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MapVirtualKeyExW"
  c_MapVirtualKeyExW :: Word32 -> Word32 -> Ptr () -> IO Word32
-- uCode : DWORD -> Word32
-- uMapType : MAP_VIRTUAL_KEY_TYPE -> Word32
-- dwhkl : HKL optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mapvirtualkeyexw =
  foreign "MapVirtualKeyExW"
    (uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* uCode : DWORD -> uint32_t *)
(* uMapType : MAP_VIRTUAL_KEY_TYPE -> uint32_t *)
(* dwhkl : HKL optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("MapVirtualKeyExW" map-virtual-key-ex-w :convention :stdcall) :uint32
  (u-code :uint32)   ; DWORD
  (u-map-type :uint32)   ; MAP_VIRTUAL_KEY_TYPE
  (dwhkl :pointer))   ; HKL optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MapVirtualKeyExW = Win32::API::More->new('USER32',
    'DWORD MapVirtualKeyExW(DWORD uCode, DWORD uMapType, HANDLE dwhkl)');
# my $ret = $MapVirtualKeyExW->Call($uCode, $uMapType, $dwhkl);
# uCode : DWORD -> DWORD
# uMapType : MAP_VIRTUAL_KEY_TYPE -> DWORD
# dwhkl : HKL optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目
使用する型