Win32 API 日本語リファレンス
ホームSystem.Console › SetConsoleCursor

SetConsoleCursor

関数
コンソールウィンドウのマウスカーソル形状を設定する内部関数。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL SetConsoleCursor(
    HANDLE hConsoleOutput,
    HCURSOR hCursor
);

パラメーター

名前方向説明
hConsoleOutputHANDLEin対象のコンソール画面バッファのハンドル。
hCursorHCURSORinコンソールに設定するマウスカーソルのハンドル(HCURSOR)。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetConsoleCursor = ctypes.windll.kernel32.SetConsoleCursor
SetConsoleCursor.restype = wintypes.BOOL
SetConsoleCursor.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    wintypes.HANDLE,  # hCursor : HCURSOR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsoleCursor = kernel32.NewProc("SetConsoleCursor")
)

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

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

typedef SetConsoleCursorNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SetConsoleCursorDart = int Function(Pointer<Void>, Pointer<Void>);
final SetConsoleCursor = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetConsoleCursorNative, SetConsoleCursorDart>('SetConsoleCursor');
// hConsoleOutput : HANDLE -> Pointer<Void>
// hCursor : HCURSOR -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetConsoleCursor(
  hConsoleOutput: THandle;   // HANDLE
  hCursor: THandle   // HCURSOR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetConsoleCursor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetConsoleCursor"
  c_SetConsoleCursor :: Ptr () -> Ptr () -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- hCursor : HCURSOR -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setconsolecursor =
  foreign "SetConsoleCursor"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* hCursor : HCURSOR -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

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