Win32 API 日本語リファレンス
ホームUI.Accessibility › RegisterPointerInputTarget

RegisterPointerInputTarget

関数
指定ポインター種別の入力対象ウィンドウを登録する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL RegisterPointerInputTarget(
    HWND hwnd,
    POINTER_INPUT_TYPE pointerType
);

パラメーター

名前方向説明
hwndHWNDin

グローバルなリダイレクト対象として登録するウィンドウ。

リダイレクトによって、フォアグラウンドウィンドウがアクティブ化 (フォーカス) を失うことがあります。これを避けるには、ウィンドウをメッセージ専用ウィンドウにするか、WS_EX_NOACTIVATE スタイルを設定してください。

pointerTypePOINTER_INPUT_TYPEin指定したウィンドウにリダイレクトするポインター入力の種類。POINTER_INPUT_TYPE 列挙型の有効かつサポートされている値を指定します。汎用の PT_POINTER 型と PT_MOUSE 型は、このパラメーターでは無効である点に注意してください。

戻り値の型: BOOL

公式ドキュメント

指定した種類のポインター入力をすべてリダイレクトする対象ウィンドウを、呼び出し元が登録できるようにします。

戻り値

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

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

解説(Remarks)

UI Access 特権を持つアプリケーションは、この関数を使用して自身のウィンドウを登録し、指定した種類のポインター入力をすべて受け取ることができます。各デスクトップでは、ポインター入力の種類ごとに、このようなグローバルなリダイレクト対象ウィンドウを同時に 1 つだけ許可します。最初に登録に成功したウィンドウは、そのウィンドウが登録解除されるか破棄されるまで有効であり続け、その時点で次の資格を持つ呼び出し元がその役割を利用できるようになります。

登録が有効な間は、入力デバイスからの入力か、アプリケーションによって挿入された入力かを問わず、指定した種類のポインター入力はすべて登録済みのウィンドウにリダイレクトされます。ただし、登録済みウィンドウを所有するプロセスが、指定した種類のポインター入力を挿入した場合、その挿入された入力はリダイレクトされず、通常どおりに処理されます。

同一のウィンドウを複数の種類のポインター入力に対するグローバルなリダイレクト対象として登録したい場合、アプリケーションは対象とするポインター入力の種類ごとに 1 回ずつ、RegisterPointerInputTarget 関数を複数回呼び出す必要があります。

呼び出し元のスレッドが UI Access 特権を持たない場合、この関数は失敗し、最後のエラーは ERROR_ACCESS_DENIED に設定されます。

指定したポインター入力の種類が無効な場合、この関数は失敗し、最後のエラーは ERROR_INVALID_PARAMETER に設定されます。

呼び出し元のスレッドが指定したウィンドウを所有していない場合、この関数は失敗し、最後のエラーは ERROR_ACCESS_DENIED に設定されます。

指定したウィンドウのデスクトップに、指定したポインター入力の種類に対するグローバルなリダイレクト対象が既に登録されている場合、この関数は失敗し、最後のエラーは ERROR_ACCESS_DENIED に設定されます。

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

各言語での呼び出し定義

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

BOOL RegisterPointerInputTarget(
    HWND hwnd,
    POINTER_INPUT_TYPE pointerType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool RegisterPointerInputTarget(
    IntPtr hwnd,   // HWND
    int pointerType   // POINTER_INPUT_TYPE
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterPointerInputTarget(
    hwnd As IntPtr,   ' HWND
    pointerType As Integer   ' POINTER_INPUT_TYPE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hwnd : HWND
' pointerType : POINTER_INPUT_TYPE
Declare PtrSafe Function RegisterPointerInputTarget Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal pointerType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterPointerInputTarget = ctypes.windll.user32.RegisterPointerInputTarget
RegisterPointerInputTarget.restype = wintypes.BOOL
RegisterPointerInputTarget.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_int,  # pointerType : POINTER_INPUT_TYPE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procRegisterPointerInputTarget = user32.NewProc("RegisterPointerInputTarget")
)

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

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

typedef RegisterPointerInputTargetNative = Int32 Function(Pointer<Void>, Int32);
typedef RegisterPointerInputTargetDart = int Function(Pointer<Void>, int);
final RegisterPointerInputTarget = DynamicLibrary.open('USER32.dll')
    .lookupFunction<RegisterPointerInputTargetNative, RegisterPointerInputTargetDart>('RegisterPointerInputTarget');
// hwnd : HWND -> Pointer<Void>
// pointerType : POINTER_INPUT_TYPE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterPointerInputTarget(
  hwnd: THandle;   // HWND
  pointerType: Integer   // POINTER_INPUT_TYPE
): BOOL; stdcall;
  external 'USER32.dll' name 'RegisterPointerInputTarget';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterPointerInputTarget"
  c_RegisterPointerInputTarget :: Ptr () -> Int32 -> IO CInt
-- hwnd : HWND -> Ptr ()
-- pointerType : POINTER_INPUT_TYPE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let registerpointerinputtarget =
  foreign "RegisterPointerInputTarget"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* hwnd : HWND -> (ptr void) *)
(* pointerType : POINTER_INPUT_TYPE -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("RegisterPointerInputTarget" register-pointer-input-target :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND
  (pointer-type :int32))   ; POINTER_INPUT_TYPE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterPointerInputTarget = Win32::API::More->new('USER32',
    'BOOL RegisterPointerInputTarget(HANDLE hwnd, int pointerType)');
# my $ret = $RegisterPointerInputTarget->Call($hwnd, $pointerType);
# hwnd : HWND -> HANDLE
# pointerType : POINTER_INPUT_TYPE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型