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

SetConsoleCursorMode

関数
コンソールカーソルの点滅やダブルバイトモードを設定する内部関数。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL SetConsoleCursorMode(
    HANDLE hConsoleHandle,
    BOOL Blink,
    BOOL DBEnable
);

パラメーター

名前方向説明
hConsoleHandleHANDLEin対象コンソール画面バッファのハンドル。
BlinkBOOLinカーソルを点滅させるならTRUE、点滅させないならFALSEを指定する。
DBEnableBOOLinダブルバイト(全角)カーソル表示を有効化するならTRUE、無効ならFALSE。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetConsoleCursorMode = ctypes.windll.kernel32.SetConsoleCursorMode
SetConsoleCursorMode.restype = wintypes.BOOL
SetConsoleCursorMode.argtypes = [
    wintypes.HANDLE,  # hConsoleHandle : HANDLE
    wintypes.BOOL,  # Blink : BOOL
    wintypes.BOOL,  # DBEnable : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsoleCursorMode = kernel32.NewProc("SetConsoleCursorMode")
)

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

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

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

foreign import stdcall safe "SetConsoleCursorMode"
  c_SetConsoleCursorMode :: Ptr () -> CInt -> CInt -> IO CInt
-- hConsoleHandle : HANDLE -> Ptr ()
-- Blink : BOOL -> CInt
-- DBEnable : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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