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

ImmGetVirtualKey

関数
IMEが処理する前の元の仮想キーコードを取得する。
DLLIMM32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// IMM32.dll
#include <windows.h>

DWORD ImmGetVirtualKey(
    HWND param0
);

パラメーター

名前方向説明
param0HWNDin対象ウィンドウのハンドル。IME処理前の仮想キーコードを取得する。

戻り値の型: DWORD

公式ドキュメント

ImmGetVirtualKey 関数 (immdev.h) は、IME がすでに処理したキー入力メッセージに関連付けられた元の仮想キー値を取得します。

戻り値

アプリケーションによって TranslateMessage が呼び出されている場合、ImmGetVirtualKeyVK_PROCESSKEY を返します。それ以外の場合は、仮想キーを返します。

解説(Remarks)

IME はキー入力メッセージを処理した後、仮想キー値を VK_PROCESSKEY に設定しますが、アプリケーションは ImmGetVirtualKey 関数を使用して元の仮想キー値を復元できます。この関数は、VK_PROCESSKEY 値を含むキー入力メッセージに対してのみ使用されます。アプリケーションがこの関数を使用して元の仮想キーを取得できるのは、

WM_KEYDOWN (VK_PROCESSKEY) メッセージを受け取った後、かつ独自のメッセージループ内で

TranslateMessage が呼び出される前に限られます。

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

各言語での呼び出し定義

// IMM32.dll
#include <windows.h>

DWORD ImmGetVirtualKey(
    HWND param0
);
[DllImport("IMM32.dll", ExactSpelling = true)]
static extern uint ImmGetVirtualKey(
    IntPtr param0   // HWND
);
<DllImport("IMM32.dll", ExactSpelling:=True)>
Public Shared Function ImmGetVirtualKey(
    param0 As IntPtr   ' HWND
) As UInteger
End Function
' param0 : HWND
Declare PtrSafe Function ImmGetVirtualKey Lib "imm32" ( _
    ByVal param0 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImmGetVirtualKey = ctypes.windll.imm32.ImmGetVirtualKey
ImmGetVirtualKey.restype = wintypes.DWORD
ImmGetVirtualKey.argtypes = [
    wintypes.HANDLE,  # param0 : HWND
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IMM32.dll')
ImmGetVirtualKey = Fiddle::Function.new(
  lib['ImmGetVirtualKey'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HWND
  ],
  -Fiddle::TYPE_INT)
#[link(name = "imm32")]
extern "system" {
    fn ImmGetVirtualKey(
        param0: *mut core::ffi::c_void  // HWND
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IMM32.dll")]
public static extern uint ImmGetVirtualKey(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IMM32_ImmGetVirtualKey' -Namespace Win32 -PassThru
# $api::ImmGetVirtualKey(param0)
#uselib "IMM32.dll"
#func global ImmGetVirtualKey "ImmGetVirtualKey" sptr
; ImmGetVirtualKey param0   ; 戻り値は stat
; param0 : HWND -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IMM32.dll"
#cfunc global ImmGetVirtualKey "ImmGetVirtualKey" sptr
; res = ImmGetVirtualKey(param0)
; param0 : HWND -> "sptr"
; DWORD ImmGetVirtualKey(HWND param0)
#uselib "IMM32.dll"
#cfunc global ImmGetVirtualKey "ImmGetVirtualKey" intptr
; res = ImmGetVirtualKey(param0)
; param0 : HWND -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imm32 = windows.NewLazySystemDLL("IMM32.dll")
	procImmGetVirtualKey = imm32.NewProc("ImmGetVirtualKey")
)

// param0 (HWND)
r1, _, err := procImmGetVirtualKey.Call(
	uintptr(param0),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ImmGetVirtualKey(
  param0: THandle   // HWND
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetVirtualKey';
result := DllCall("IMM32\ImmGetVirtualKey"
    , "Ptr", param0   ; HWND
    , "UInt")   ; return: DWORD
●ImmGetVirtualKey(param0) = DLL("IMM32.dll", "dword ImmGetVirtualKey(void*)")
# 呼び出し: ImmGetVirtualKey(param0)
# param0 : HWND -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "imm32" fn ImmGetVirtualKey(
    param0: ?*anyopaque // HWND
) callconv(std.os.windows.WINAPI) u32;
proc ImmGetVirtualKey(
    param0: pointer  # HWND
): uint32 {.importc: "ImmGetVirtualKey", stdcall, dynlib: "IMM32.dll".}
pragma(lib, "imm32");
extern(Windows)
uint ImmGetVirtualKey(
    void* param0   // HWND
);
ccall((:ImmGetVirtualKey, "IMM32.dll"), stdcall, UInt32,
      (Ptr{Cvoid},),
      param0)
# param0 : HWND -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ImmGetVirtualKey(
    void* param0);
]]
local imm32 = ffi.load("imm32")
-- imm32.ImmGetVirtualKey(param0)
-- param0 : HWND
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IMM32.dll');
const ImmGetVirtualKey = lib.func('__stdcall', 'ImmGetVirtualKey', 'uint32_t', ['void *']);
// ImmGetVirtualKey(param0)
// param0 : HWND -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IMM32.dll", {
  ImmGetVirtualKey: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.ImmGetVirtualKey(param0)
// param0 : HWND -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ImmGetVirtualKey(
    void* param0);
C, "IMM32.dll");
// $ffi->ImmGetVirtualKey(param0);
// param0 : HWND
// 構造体/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 Imm32 extends StdCallLibrary {
    Imm32 INSTANCE = Native.load("imm32", Imm32.class);
    int ImmGetVirtualKey(
        Pointer param0   // HWND
    );
}
@[Link("imm32")]
lib LibIMM32
  fun ImmGetVirtualKey = ImmGetVirtualKey(
    param0 : Void*   # HWND
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImmGetVirtualKeyNative = Uint32 Function(Pointer<Void>);
typedef ImmGetVirtualKeyDart = int Function(Pointer<Void>);
final ImmGetVirtualKey = DynamicLibrary.open('IMM32.dll')
    .lookupFunction<ImmGetVirtualKeyNative, ImmGetVirtualKeyDart>('ImmGetVirtualKey');
// param0 : HWND -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImmGetVirtualKey(
  param0: THandle   // HWND
): DWORD; stdcall;
  external 'IMM32.dll' name 'ImmGetVirtualKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImmGetVirtualKey"
  c_ImmGetVirtualKey :: Ptr () -> IO Word32
-- param0 : HWND -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let immgetvirtualkey =
  foreign "ImmGetVirtualKey"
    ((ptr void) @-> returning uint32_t)
(* param0 : HWND -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imm32 (t "IMM32.dll"))
(cffi:use-foreign-library imm32)

(cffi:defcfun ("ImmGetVirtualKey" imm-get-virtual-key :convention :stdcall) :uint32
  (param0 :pointer))   ; HWND
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImmGetVirtualKey = Win32::API::More->new('IMM32',
    'DWORD ImmGetVirtualKey(HANDLE param0)');
# my $ret = $ImmGetVirtualKey->Call($param0);
# param0 : HWND -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。