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

GetCursorInfo

関数
現在のカーソルの状態と位置情報を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetCursorInfo(
    CURSORINFO* pci
);

パラメーター

名前方向説明
pciCURSORINFO*inout情報を受け取る CURSORINFO 構造体へのポインターです。この関数を呼び出す前に、cbSize メンバーを sizeof(CURSORINFO) に設定する必要があることに注意してください。

戻り値の型: BOOL

公式ドキュメント

グローバルカーソルに関する情報を取得します。

戻り値

型: BOOL

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

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

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

各言語での呼び出し定義

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

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

GetCursorInfo = ctypes.windll.user32.GetCursorInfo
GetCursorInfo.restype = wintypes.BOOL
GetCursorInfo.argtypes = [
    ctypes.c_void_p,  # pci : CURSORINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetCursorInfo = user32.NewProc("GetCursorInfo")
)

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

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

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

foreign import stdcall safe "GetCursorInfo"
  c_GetCursorInfo :: Ptr () -> IO CInt
-- pci : CURSORINFO* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getcursorinfo =
  foreign "GetCursorInfo"
    ((ptr void) @-> returning int32_t)
(* pci : CURSORINFO* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

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

関連項目

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