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

GetConsoleCursorMode

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

シグネチャ

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

BOOL GetConsoleCursorMode(
    HANDLE hConsoleHandle,
    BOOL* pbBlink,
    BOOL* pbDBEnable
);

パラメーター

名前方向説明
hConsoleHandleHANDLEin対象コンソール画面バッファのハンドル。
pbBlinkBOOL*outカーソルが点滅状態かどうかを受け取るBOOLポインタ。
pbDBEnableBOOL*outダブルバイトカーソル表示が有効かどうかを受け取るBOOLポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleCursorMode = ctypes.windll.kernel32.GetConsoleCursorMode
GetConsoleCursorMode.restype = wintypes.BOOL
GetConsoleCursorMode.argtypes = [
    wintypes.HANDLE,  # hConsoleHandle : HANDLE
    ctypes.c_void_p,  # pbBlink : BOOL* out
    ctypes.c_void_p,  # pbDBEnable : BOOL* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetConsoleCursorMode = Fiddle::Function.new(
  lib['GetConsoleCursorMode'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pbBlink : BOOL* out
    Fiddle::TYPE_VOIDP,  # pbDBEnable : BOOL* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetConsoleCursorMode(
        hConsoleHandle: *mut core::ffi::c_void,  // HANDLE
        pbBlink: *mut i32,  // BOOL* out
        pbDBEnable: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool GetConsoleCursorMode(IntPtr hConsoleHandle, out bool pbBlink, out bool pbDBEnable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetConsoleCursorMode' -Namespace Win32 -PassThru
# $api::GetConsoleCursorMode(hConsoleHandle, pbBlink, pbDBEnable)
#uselib "KERNEL32.dll"
#func global GetConsoleCursorMode "GetConsoleCursorMode" sptr, sptr, sptr
; GetConsoleCursorMode hConsoleHandle, varptr(pbBlink), varptr(pbDBEnable)   ; 戻り値は stat
; hConsoleHandle : HANDLE -> "sptr"
; pbBlink : BOOL* out -> "sptr"
; pbDBEnable : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetConsoleCursorMode "GetConsoleCursorMode" sptr, var, var
; res = GetConsoleCursorMode(hConsoleHandle, pbBlink, pbDBEnable)
; hConsoleHandle : HANDLE -> "sptr"
; pbBlink : BOOL* out -> "var"
; pbDBEnable : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetConsoleCursorMode(HANDLE hConsoleHandle, BOOL* pbBlink, BOOL* pbDBEnable)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleCursorMode "GetConsoleCursorMode" intptr, var, var
; res = GetConsoleCursorMode(hConsoleHandle, pbBlink, pbDBEnable)
; hConsoleHandle : HANDLE -> "intptr"
; pbBlink : BOOL* out -> "var"
; pbDBEnable : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleCursorMode = kernel32.NewProc("GetConsoleCursorMode")
)

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

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

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

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

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

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