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

GetConsoleScreenBufferInfoEx

関数
コンソール画面バッファの拡張情報を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL GetConsoleScreenBufferInfoEx(
    HANDLE hConsoleOutput,
    CONSOLE_SCREEN_BUFFER_INFOEX* lpConsoleScreenBufferInfoEx
);

パラメーター

名前型方向説明
hConsoleOutputHANDLEin対象のコンソール画面バッファのハンドル。
lpConsoleScreenBufferInfoExCONSOLE_SCREEN_BUFFER_INFOEX*inout拡張バッファ情報(カラーテーブル含む)を受け取るCONSOLE_SCREEN_BUFFER_INFOEX出力ポインタ。cbSizeの設定が必要。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

GetConsoleScreenBufferInfoEx = ctypes.windll.kernel32.GetConsoleScreenBufferInfoEx
GetConsoleScreenBufferInfoEx.restype = wintypes.BOOL
GetConsoleScreenBufferInfoEx.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    ctypes.c_void_p,  # lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleScreenBufferInfoEx = kernel32.NewProc("GetConsoleScreenBufferInfoEx")
)

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

extern "kernel32" fn GetConsoleScreenBufferInfoEx(
    hConsoleOutput: ?*anyopaque, // HANDLE
    lpConsoleScreenBufferInfoEx: [*c]CONSOLE_SCREEN_BUFFER_INFOEX // CONSOLE_SCREEN_BUFFER_INFOEX* in/out
) callconv(std.os.windows.WINAPI) i32;
proc GetConsoleScreenBufferInfoEx(
    hConsoleOutput: pointer,  # HANDLE
    lpConsoleScreenBufferInfoEx: ptr CONSOLE_SCREEN_BUFFER_INFOEX  # CONSOLE_SCREEN_BUFFER_INFOEX* in/out
): int32 {.importc: "GetConsoleScreenBufferInfoEx", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetConsoleScreenBufferInfoEx(
    void* hConsoleOutput,   // HANDLE
    CONSOLE_SCREEN_BUFFER_INFOEX* lpConsoleScreenBufferInfoEx   // CONSOLE_SCREEN_BUFFER_INFOEX* in/out
);
ccall((:GetConsoleScreenBufferInfoEx, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{CONSOLE_SCREEN_BUFFER_INFOEX}),
      hConsoleOutput, lpConsoleScreenBufferInfoEx)
# hConsoleOutput : HANDLE -> Ptr{Cvoid}
# lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out -> Ptr{CONSOLE_SCREEN_BUFFER_INFOEX}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetConsoleScreenBufferInfoEx(
    void* hConsoleOutput,
    void* lpConsoleScreenBufferInfoEx);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetConsoleScreenBufferInfoEx(hConsoleOutput, lpConsoleScreenBufferInfoEx)
-- hConsoleOutput : HANDLE
-- lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetConsoleScreenBufferInfoEx = lib.func('__stdcall', 'GetConsoleScreenBufferInfoEx', 'int32_t', ['void *', 'void *']);
// GetConsoleScreenBufferInfoEx(hConsoleOutput, lpConsoleScreenBufferInfoEx)
// hConsoleOutput : HANDLE -> 'void *'
// lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetConsoleScreenBufferInfoEx: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetConsoleScreenBufferInfoEx(hConsoleOutput, lpConsoleScreenBufferInfoEx)
// hConsoleOutput : HANDLE -> "pointer"
// lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetConsoleScreenBufferInfoEx(
    void* hConsoleOutput,
    void* lpConsoleScreenBufferInfoEx);
C, "KERNEL32.dll");
// $ffi->GetConsoleScreenBufferInfoEx(hConsoleOutput, lpConsoleScreenBufferInfoEx);
// hConsoleOutput : HANDLE
// lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean GetConsoleScreenBufferInfoEx(
        Pointer hConsoleOutput,   // HANDLE
        Pointer lpConsoleScreenBufferInfoEx   // CONSOLE_SCREEN_BUFFER_INFOEX* in/out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetConsoleScreenBufferInfoEx = GetConsoleScreenBufferInfoEx(
    hConsoleOutput : Void*,   # HANDLE
    lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX*   # CONSOLE_SCREEN_BUFFER_INFOEX* 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 GetConsoleScreenBufferInfoExNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetConsoleScreenBufferInfoExDart = int Function(Pointer<Void>, Pointer<Void>);
final GetConsoleScreenBufferInfoEx = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetConsoleScreenBufferInfoExNative, GetConsoleScreenBufferInfoExDart>('GetConsoleScreenBufferInfoEx');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetConsoleScreenBufferInfoEx(
  hConsoleOutput: THandle;   // HANDLE
  lpConsoleScreenBufferInfoEx: Pointer   // CONSOLE_SCREEN_BUFFER_INFOEX* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleScreenBufferInfoEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("GetConsoleScreenBufferInfoEx" get-console-screen-buffer-info-ex :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (lp-console-screen-buffer-info-ex :pointer))   ; CONSOLE_SCREEN_BUFFER_INFOEX* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetConsoleScreenBufferInfoEx = Win32::API::More->new('KERNEL32',
    'BOOL GetConsoleScreenBufferInfoEx(HANDLE hConsoleOutput, LPVOID lpConsoleScreenBufferInfoEx)');
# my $ret = $GetConsoleScreenBufferInfoEx->Call($hConsoleOutput, $lpConsoleScreenBufferInfoEx);
# hConsoleOutput : HANDLE -> HANDLE
# lpConsoleScreenBufferInfoEx : CONSOLE_SCREEN_BUFFER_INFOEX* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型