ホーム › UI.Input.KeyboardAndMouse › SetKeyboardState

SetKeyboardState

関数

全仮想キーの状態を配列でまとめて設定する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetKeyboardState(
    BYTE* lpKeyState
);

パラメーター

名前	型	方向	説明
lpKeyState	BYTE*	in	キーボードのキー状態を格納する 256 バイトの配列へのポインターです。

戻り値の型: BOOL

公式ドキュメント

キーボードのキー状態の配列を、呼び出し元スレッドのキーボード入力状態テーブルにコピーします。これは GetKeyboardState 関数および GetKeyState 関数がアクセスするのと同じテーブルです。このテーブルへの変更は、他のスレッドへのキーボード入力には影響しません。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

SetKeyboardState 関数はシステム全体のグローバルな入力状態ではなく呼び出し元スレッドの入力状態を変更するため、アプリケーションは SetKeyboardState を使用してキーボードの NUM LOCK、CAPS LOCK、SCROLL LOCK(または日本語の KANA)のインジケーターランプを設定することはできません。これらは SendInput を使用してキー入力をシミュレートすることで、設定またはクリアできます。

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

各言語での呼び出し定義

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

BOOL SetKeyboardState(
    BYTE* lpKeyState
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetKeyboardState(
    IntPtr lpKeyState   // BYTE*
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetKeyboardState(
    lpKeyState As IntPtr   ' BYTE*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpKeyState : BYTE*
Declare PtrSafe Function SetKeyboardState Lib "user32" ( _
    ByVal lpKeyState As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetKeyboardState = ctypes.windll.user32.SetKeyboardState
SetKeyboardState.restype = wintypes.BOOL
SetKeyboardState.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # lpKeyState : BYTE*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetKeyboardState = Fiddle::Function.new(
  lib['SetKeyboardState'],
  [
    Fiddle::TYPE_VOIDP,  # lpKeyState : BYTE*
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn SetKeyboardState(
        lpKeyState: *mut u8  // BYTE*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool SetKeyboardState(IntPtr lpKeyState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetKeyboardState' -Namespace Win32 -PassThru
# $api::SetKeyboardState(lpKeyState)

#uselib "USER32.dll"
#func global SetKeyboardState "SetKeyboardState" sptr
; SetKeyboardState varptr(lpKeyState)   ; 戻り値は stat
; lpKeyState : BYTE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global SetKeyboardState "SetKeyboardState" var
; res = SetKeyboardState(lpKeyState)
; lpKeyState : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global SetKeyboardState "SetKeyboardState" sptr
; res = SetKeyboardState(varptr(lpKeyState))
; lpKeyState : BYTE* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。