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

BlockInput

関数
キーボードとマウスの入力をブロックまたは解除する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL BlockInput(
    BOOL fBlockIt
);

パラメーター

名前方向説明
fBlockItBOOLinこの関数の動作を指定します。このパラメーターが TRUE の場合、キーボードおよびマウスの入力イベントがブロックされます。FALSE の場合、キーボードおよびマウスのイベントのブロックが解除されます。入力をブロックしたスレッドのみが入力のブロックを正常に解除できる点に注意してください。

戻り値の型: BOOL

公式ドキュメント

キーボードおよびマウスの入力イベントがアプリケーションに到達するのをブロックします。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外になります。

入力が既にブロックされている場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

入力がブロックされている間、マウスやキーボードからの実際の物理的な入力は、入力キューの同期キー状態(GetKeyState および GetKeyboardState によって報告される)に影響を与えず、また非同期キー状態(GetAsyncKeyState によって報告される)にも影響を与えません。ただし、入力をブロックしているスレッドは、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 BlockInput(
    BOOL fBlockIt
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool BlockInput(
    bool fBlockIt   // BOOL
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BlockInput(
    fBlockIt As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' fBlockIt : BOOL
Declare PtrSafe Function BlockInput Lib "user32" ( _
    ByVal fBlockIt As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BlockInput = ctypes.windll.user32.BlockInput
BlockInput.restype = wintypes.BOOL
BlockInput.argtypes = [
    wintypes.BOOL,  # fBlockIt : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
BlockInput = Fiddle::Function.new(
  lib['BlockInput'],
  [
    Fiddle::TYPE_INT,  # fBlockIt : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn BlockInput(
        fBlockIt: i32  // BOOL
    ) -> 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 BlockInput(bool fBlockIt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_BlockInput' -Namespace Win32 -PassThru
# $api::BlockInput(fBlockIt)
#uselib "USER32.dll"
#func global BlockInput "BlockInput" sptr
; BlockInput fBlockIt   ; 戻り値は stat
; fBlockIt : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global BlockInput "BlockInput" int
; res = BlockInput(fBlockIt)
; fBlockIt : BOOL -> "int"
; BOOL BlockInput(BOOL fBlockIt)
#uselib "USER32.dll"
#cfunc global BlockInput "BlockInput" int
; res = BlockInput(fBlockIt)
; fBlockIt : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procBlockInput = user32.NewProc("BlockInput")
)

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

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

typedef BlockInputNative = Int32 Function(Int32);
typedef BlockInputDart = int Function(int);
final BlockInput = DynamicLibrary.open('USER32.dll')
    .lookupFunction<BlockInputNative, BlockInputDart>('BlockInput');
// fBlockIt : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BlockInput(
  fBlockIt: BOOL   // BOOL
): BOOL; stdcall;
  external 'USER32.dll' name 'BlockInput';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BlockInput"
  c_BlockInput :: CInt -> IO CInt
-- fBlockIt : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let blockinput =
  foreign "BlockInput"
    (int32_t @-> returning int32_t)
(* fBlockIt : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("BlockInput" block-input :convention :stdcall) :int32
  (f-block-it :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BlockInput = Win32::API::More->new('USER32',
    'BOOL BlockInput(BOOL fBlockIt)');
# my $ret = $BlockInput->Call($fBlockIt);
# fBlockIt : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目