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

OemKeyScan

関数
OEM ASCII文字をスキャンコードとシフト状態に変換する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OemKeyScan(
    WORD wOemChar
);

パラメーター

名前方向説明
wOemCharWORDinOEM 文字の ASCII 値。

戻り値の型: DWORD

公式ドキュメント

OEMASCII コード 0 から 0x0FF を OEM スキャンコードとシフト状態にマップします。この関数は、キーボード入力をシミュレートすることで、あるプログラムが別のプログラムに OEM テキストを送信できるようにする情報を提供します。

戻り値

型: DWORD

戻り値の下位ワードには OEM 文字のスキャンコードが格納され、上位ワードにはシフト状態が格納されます。シフト状態は次のビットの組み合わせになります。

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

現在のキーボードレイアウトで 1 回のキー操作では生成できない文字の場合、戻り値は –1 になります。

解説(Remarks)

この関数は、CTRL+ALT やデッドキーを必要とする文字の変換は行いません。この関数で変換されない文字は、ALT+ テンキーの方式で入力をシミュレートしてコピーする必要があります。NUMLOCK キーはオフにしておく必要があります。

この関数は、ダイアクリティカルマーク付きの文字でデッドキーを必要とするものなど、現在のキーボードレイアウトで 1 回のキー操作では入力できない文字の変換は行いません。この関数で変換されない文字は、ALT+ テンキーの方式でシミュレートできます。NUMLOCK キーはオンにしておく必要があります。

この関数は VkKeyScan 関数を使用して実装されています。

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

各言語での呼び出し定義

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

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

OemKeyScan = ctypes.windll.user32.OemKeyScan
OemKeyScan.restype = wintypes.DWORD
OemKeyScan.argtypes = [
    ctypes.c_ushort,  # wOemChar : WORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procOemKeyScan = user32.NewProc("OemKeyScan")
)

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

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

typedef OemKeyScanNative = Uint32 Function(Uint16);
typedef OemKeyScanDart = int Function(int);
final OemKeyScan = DynamicLibrary.open('USER32.dll')
    .lookupFunction<OemKeyScanNative, OemKeyScanDart>('OemKeyScan');
// wOemChar : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OemKeyScan(
  wOemChar: Word   // WORD
): DWORD; stdcall;
  external 'USER32.dll' name 'OemKeyScan';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let oemkeyscan =
  foreign "OemKeyScan"
    (uint16_t @-> returning uint32_t)
(* wOemChar : WORD -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

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

関連項目

公式の関連項目