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

SetCapture

関数
指定ウィンドウにマウス入力をキャプチャさせる。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HWND SetCapture(
    HWND hWnd
);

パラメーター

名前方向説明
hWndHWNDinマウスをキャプチャする、現在のスレッド内のウィンドウへのハンドルです。

戻り値の型: HWND

公式ドキュメント

マウスのキャプチャを、現在のスレッドに属する指定したウィンドウに設定します。

戻り値

型: HWND

戻り値は、以前にマウスをキャプチャしていたウィンドウへのハンドルです。そのようなウィンドウが存在しない場合、戻り値は NULL になります。

解説(Remarks)

マウスをキャプチャできるのはフォアグラウンドウィンドウのみです。バックグラウンドウィンドウがマウスをキャプチャしようとした場合、そのウィンドウは、カーソルのホットスポットがウィンドウの表示部分内にあるときに発生したマウスイベントについてのみメッセージを受け取ります。また、フォアグラウンドウィンドウがマウスをキャプチャしている場合でも、ユーザーは別のウィンドウをクリックして、そのウィンドウをフォアグラウンドに移動できます。

ウィンドウがすべてのマウス入力を必要としなくなったときは、そのウィンドウを作成したスレッドが ReleaseCapture 関数を呼び出してマウスを解放する必要があります。

この関数は、別のプロセス向けのマウス入力をキャプチャするためには使用できません。

マウスがキャプチャされている間は、メニューのホットキーやその他のキーボードアクセラレータは機能しません。

例については、Drawing Lines with the Mouse を参照してください。

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

各言語での呼び出し定義

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

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

SetCapture = ctypes.windll.user32.SetCapture
SetCapture.restype = ctypes.c_void_p
SetCapture.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetCapture = user32.NewProc("SetCapture")
)

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

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

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

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

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

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

関連項目

公式の関連項目