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

SetSystemCursor

関数
指定したシステムカーソルを別のカーソルに置き換える。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetSystemCursor(
    HCURSOR hcur,
    SYSTEM_CURSOR_ID id
);

パラメーター

名前方向説明
hcurHCURSORin

カーソルへのハンドルです。この関数は、id で指定されたシステムカーソルの内容を、hcur が指すカーソルの内容に置き換えます。

システムは DestroyCursor 関数を呼び出して hcur を破棄します。したがって、hcur には LoadCursor 関数で読み込んだカーソルを指定することはできません。リソースから読み込んだカーソルを指定するには、CopyCursor 関数でカーソルをコピーし、そのコピーを SetSystemCursor に渡してください。

idSYSTEM_CURSOR_IDin

hcur の内容で置き換えるシステムカーソルです。このパラメーターには次のいずれかの値を指定できます。

意味
OCR_NORMAL
32512
通常の選択
OCR_IBEAM
32513
テキストの選択
OCR_WAIT
32514
待機中
OCR_CROSS
32515
精密な選択
OCR_UP
32516
代替選択
OCR_SIZENWSE
32642
斜めのサイズ変更 1
OCR_SIZENESW
32643
斜めのサイズ変更 2
OCR_SIZEWE
32644
水平方向のサイズ変更
OCR_SIZENS
32645
垂直方向のサイズ変更
OCR_SIZEALL
32646
移動
OCR_NO
32648
使用不可
OCR_HAND
32649
リンクの選択
OCR_APPSTARTING
32650
バックグラウンドで処理中

戻り値の型: BOOL

公式ドキュメント

アプリケーションがシステムカーソルをカスタマイズできるようにします。id パラメーターで指定されたシステムカーソルの内容を、hcur パラメーターで指定されたカーソルの内容に置き換え、その後 hcur を破棄します。

戻り値

型: BOOL

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

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

解説(Remarks)

アプリケーションで OCR_ 定数を使用するには、Windows.h ヘッダーファイルをインクルードする前に OEMRESOURCE 定数を定義しておく必要があります。

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

各言語での呼び出し定義

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

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

SetSystemCursor = ctypes.windll.user32.SetSystemCursor
SetSystemCursor.restype = wintypes.BOOL
SetSystemCursor.argtypes = [
    wintypes.HANDLE,  # hcur : HCURSOR
    wintypes.DWORD,  # id : SYSTEM_CURSOR_ID
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetSystemCursor = user32.NewProc("SetSystemCursor")
)

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

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

typedef SetSystemCursorNative = Int32 Function(Pointer<Void>, Uint32);
typedef SetSystemCursorDart = int Function(Pointer<Void>, int);
final SetSystemCursor = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetSystemCursorNative, SetSystemCursorDart>('SetSystemCursor');
// hcur : HCURSOR -> Pointer<Void>
// id : SYSTEM_CURSOR_ID -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetSystemCursor(
  hcur: THandle;   // HCURSOR
  id: DWORD   // SYSTEM_CURSOR_ID
): BOOL; stdcall;
  external 'USER32.dll' name 'SetSystemCursor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetSystemCursor"
  c_SetSystemCursor :: Ptr () -> Word32 -> IO CInt
-- hcur : HCURSOR -> Ptr ()
-- id : SYSTEM_CURSOR_ID -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setsystemcursor =
  foreign "SetSystemCursor"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hcur : HCURSOR -> (ptr void) *)
(* id : SYSTEM_CURSOR_ID -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

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

関連項目

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