ホーム › UI.WindowsAndMessaging › SetCursor
SetCursor
関数現在のマウスカーソルの形状を設定する。
シグネチャ
// USER32.dll
#include <windows.h>
HCURSOR SetCursor(
HCURSOR hCursor // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hCursor | HCURSOR | inoptional | カーソルのハンドルです。 カーソルは、CreateCursor 関数または CreateIconIndirect 関数で作成されたものか、LoadCursor 関数または LoadImage 関数で読み込まれたものである必要があります。 このパラメーターが NULL の場合、カーソルは画面から削除されます。 |
戻り値の型: HCURSOR
公式ドキュメント
カーソルの形状を設定します。
戻り値
型: HCURSOR
直前のカーソルが存在した場合、戻り値はそのカーソルのハンドルです。
直前のカーソルが存在しなかった場合、戻り値は NULL です。
解説(Remarks)
カーソルは、新しいカーソルが直前のカーソルと異なる場合にのみ設定されます。異ならない場合、関数は直ちに戻ります。
カーソルは共有リソースです。ウィンドウは、カーソルがクライアント領域内にあるとき、またはウィンドウがマウス入力をキャプチャしているときにのみ、カーソルの形状を設定すべきです。マウスのないシステムでは、ウィンドウはカーソルがクライアント領域を離れる前、または制御を別のウィンドウに引き渡す前に、直前のカーソルを復元すべきです。
アプリケーションがウィンドウ内でカーソルを設定する必要がある場合は、指定したウィンドウのクラスのクラスカーソルが NULL に設定されていることを確認してください。クラスカーソルが NULL でない場合、マウスが移動するたびにシステムがクラスカーソルを復元します。
内部のカーソル表示カウントが 0 未満の場合、カーソルは画面に表示されません。これは、アプリケーションが ShowCursor 関数を使用して、カーソルを表示する回数よりも多く非表示にした場合に発生します。
例
例については、カーソルの表示を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
HCURSOR SetCursor(
HCURSOR hCursor // optional
);[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr SetCursor(
IntPtr hCursor // HCURSOR optional
);<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function SetCursor(
hCursor As IntPtr ' HCURSOR optional
) As IntPtr
End Function' hCursor : HCURSOR optional
Declare PtrSafe Function SetCursor Lib "user32" ( _
ByVal hCursor As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetCursor = ctypes.windll.user32.SetCursor
SetCursor.restype = ctypes.c_void_p
SetCursor.argtypes = [
wintypes.HANDLE, # hCursor : HCURSOR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
SetCursor = Fiddle::Function.new(
lib['SetCursor'],
[
Fiddle::TYPE_VOIDP, # hCursor : HCURSOR optional
],
Fiddle::TYPE_VOIDP)#[link(name = "user32")]
extern "system" {
fn SetCursor(
hCursor: *mut core::ffi::c_void // HCURSOR optional
) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll")]
public static extern IntPtr SetCursor(IntPtr hCursor);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetCursor' -Namespace Win32 -PassThru
# $api::SetCursor(hCursor)#uselib "USER32.dll"
#func global SetCursor "SetCursor" sptr
; SetCursor hCursor ; 戻り値は stat
; hCursor : HCURSOR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global SetCursor "SetCursor" sptr
; res = SetCursor(hCursor)
; hCursor : HCURSOR optional -> "sptr"; HCURSOR SetCursor(HCURSOR hCursor)
#uselib "USER32.dll"
#cfunc global SetCursor "SetCursor" intptr
; res = SetCursor(hCursor)
; hCursor : HCURSOR optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procSetCursor = user32.NewProc("SetCursor")
)
// hCursor (HCURSOR optional)
r1, _, err := procSetCursor.Call(
uintptr(hCursor),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HCURSORfunction SetCursor(
hCursor: THandle // HCURSOR optional
): THandle; stdcall;
external 'USER32.dll' name 'SetCursor';result := DllCall("USER32\SetCursor"
, "Ptr", hCursor ; HCURSOR optional
, "Ptr") ; return: HCURSOR●SetCursor(hCursor) = DLL("USER32.dll", "void* SetCursor(void*)")
# 呼び出し: SetCursor(hCursor)
# hCursor : HCURSOR optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn SetCursor(
hCursor: ?*anyopaque // HCURSOR optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc SetCursor(
hCursor: pointer # HCURSOR optional
): pointer {.importc: "SetCursor", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
void* SetCursor(
void* hCursor // HCURSOR optional
);ccall((:SetCursor, "USER32.dll"), stdcall, Ptr{Cvoid},
(Ptr{Cvoid},),
hCursor)
# hCursor : HCURSOR optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* SetCursor(
void* hCursor);
]]
local user32 = ffi.load("user32")
-- user32.SetCursor(hCursor)
-- hCursor : HCURSOR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetCursor = lib.func('__stdcall', 'SetCursor', 'void *', ['void *']);
// SetCursor(hCursor)
// hCursor : HCURSOR optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
SetCursor: { parameters: ["pointer"], result: "pointer" },
});
// lib.symbols.SetCursor(hCursor)
// hCursor : HCURSOR optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* SetCursor(
void* hCursor);
C, "USER32.dll");
// $ffi->SetCursor(hCursor);
// hCursor : HCURSOR 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);
Pointer SetCursor(
Pointer hCursor // HCURSOR optional
);
}@[Link("user32")]
lib LibUSER32
fun SetCursor = SetCursor(
hCursor : Void* # HCURSOR optional
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SetCursorNative = Pointer<Void> Function(Pointer<Void>);
typedef SetCursorDart = Pointer<Void> Function(Pointer<Void>);
final SetCursor = DynamicLibrary.open('USER32.dll')
.lookupFunction<SetCursorNative, SetCursorDart>('SetCursor');
// hCursor : HCURSOR optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetCursor(
hCursor: THandle // HCURSOR optional
): THandle; stdcall;
external 'USER32.dll' name 'SetCursor';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetCursor"
c_SetCursor :: Ptr () -> IO (Ptr ())
-- hCursor : HCURSOR optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setcursor =
foreign "SetCursor"
((ptr void) @-> returning (ptr void))
(* hCursor : HCURSOR 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 ("SetCursor" set-cursor :convention :stdcall) :pointer
(h-cursor :pointer)) ; HCURSOR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetCursor = Win32::API::More->new('USER32',
'HANDLE SetCursor(HANDLE hCursor)');
# my $ret = $SetCursor->Call($hCursor);
# hCursor : HCURSOR optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CreateCursor — ANDマスクとXORマスクから新しいカーソルを作成する。
- f CreateIconIndirect — ICONINFO構造体の情報からアイコンを作成する。
- f GetCursor — 現在のマウスカーソルのハンドルを取得する。
- f GetSystemMetrics — 画面寸法やシステム構成要素の各種メトリクス値を取得する。
- f LoadCursorW — カーソルリソースを読み込みハンドルを返す(Unicode版)。
- f LoadImageW — アイコン・カーソル・ビットマップを読み込む(Unicode版)。
- f SetCursorPos — カーソルを指定の画面座標へ移動する。
- f ShowCursor — マウスカーソルの表示カウンタを増減し表示を制御する。