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

ClipCursor

関数
カーソルの移動範囲を指定矩形内に制限する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL ClipCursor(
    const RECT* lpRect   // optional
);

パラメーター

名前方向説明
lpRectRECT*inoptional制限する矩形の左上隅および右下隅のスクリーン座標を格納した構造体へのポインターです。このパラメーターが NULL の場合、カーソルは画面上を自由に移動できます。

戻り値の型: BOOL

公式ドキュメント

カーソルを画面上の矩形領域内に制限します。

戻り値

型: BOOL

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

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

解説(Remarks)

カーソルは共有リソースです。アプリケーションがカーソルを制限する場合は、別のアプリケーションに制御を渡す前に、ClipCursor を使用してカーソルを解放する必要があります。

呼び出し元のプロセスは、ウィンドウステーションに対する WINSTA_WRITEATTRIBUTES アクセス権を持っている必要があります。

例については、カーソルの制限を参照してください。

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

各言語での呼び出し定義

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

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

ClipCursor = ctypes.windll.user32.ClipCursor
ClipCursor.restype = wintypes.BOOL
ClipCursor.argtypes = [
    ctypes.c_void_p,  # lpRect : RECT* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ClipCursor = Fiddle::Function.new(
  lib['ClipCursor'],
  [
    Fiddle::TYPE_VOIDP,  # lpRect : RECT* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn ClipCursor(
        lpRect: *const RECT  // RECT* optional
    ) -> 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 ClipCursor(IntPtr lpRect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ClipCursor' -Namespace Win32 -PassThru
# $api::ClipCursor(lpRect)
#uselib "USER32.dll"
#func global ClipCursor "ClipCursor" sptr
; ClipCursor varptr(lpRect)   ; 戻り値は stat
; lpRect : RECT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global ClipCursor "ClipCursor" var
; res = ClipCursor(lpRect)
; lpRect : RECT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ClipCursor(RECT* lpRect)
#uselib "USER32.dll"
#cfunc global ClipCursor "ClipCursor" var
; res = ClipCursor(lpRect)
; lpRect : RECT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procClipCursor = user32.NewProc("ClipCursor")
)

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

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

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

foreign import stdcall safe "ClipCursor"
  c_ClipCursor :: Ptr () -> IO CInt
-- lpRect : RECT* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("ClipCursor" clip-cursor :convention :stdcall) :int32
  (lp-rect :pointer))   ; RECT* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ClipCursor = Win32::API::More->new('USER32',
    'BOOL ClipCursor(LPVOID lpRect)');
# my $ret = $ClipCursor->Call($lpRect);
# lpRect : RECT* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型