ホーム › System.Console › GetConsoleScreenBufferInfo

GetConsoleScreenBufferInfo

関数

コンソール画面バッファのサイズやカーソル位置などの情報を取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL GetConsoleScreenBufferInfo(
    HANDLE hConsoleOutput,
    CONSOLE_SCREEN_BUFFER_INFO* lpConsoleScreenBufferInfo
);

パラメーター

名前	型	方向
hConsoleOutput	HANDLE	in
lpConsoleScreenBufferInfo	CONSOLE_SCREEN_BUFFER_INFO*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetConsoleScreenBufferInfo(
    HANDLE hConsoleOutput,
    CONSOLE_SCREEN_BUFFER_INFO* lpConsoleScreenBufferInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetConsoleScreenBufferInfo(
    IntPtr hConsoleOutput,   // HANDLE
    IntPtr lpConsoleScreenBufferInfo   // CONSOLE_SCREEN_BUFFER_INFO* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetConsoleScreenBufferInfo(
    hConsoleOutput As IntPtr,   ' HANDLE
    lpConsoleScreenBufferInfo As IntPtr   ' CONSOLE_SCREEN_BUFFER_INFO* out
) As Boolean
End Function

' hConsoleOutput : HANDLE
' lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out
Declare PtrSafe Function GetConsoleScreenBufferInfo Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpConsoleScreenBufferInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetConsoleScreenBufferInfo = ctypes.windll.kernel32.GetConsoleScreenBufferInfo
GetConsoleScreenBufferInfo.restype = wintypes.BOOL
GetConsoleScreenBufferInfo.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    ctypes.c_void_p,  # lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetConsoleScreenBufferInfo = Fiddle::Function.new(
  lib['GetConsoleScreenBufferInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetConsoleScreenBufferInfo(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpConsoleScreenBufferInfo: *mut CONSOLE_SCREEN_BUFFER_INFO  // CONSOLE_SCREEN_BUFFER_INFO* 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 GetConsoleScreenBufferInfo(IntPtr hConsoleOutput, IntPtr lpConsoleScreenBufferInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetConsoleScreenBufferInfo' -Namespace Win32 -PassThru
# $api::GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)

#uselib "KERNEL32.dll"
#func global GetConsoleScreenBufferInfo "GetConsoleScreenBufferInfo" sptr, sptr
; GetConsoleScreenBufferInfo hConsoleOutput, varptr(lpConsoleScreenBufferInfo)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetConsoleScreenBufferInfo "GetConsoleScreenBufferInfo" sptr, var
; res = GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)
; hConsoleOutput : HANDLE -> "sptr"
; lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetConsoleScreenBufferInfo "GetConsoleScreenBufferInfo" sptr, sptr
; res = GetConsoleScreenBufferInfo(hConsoleOutput, varptr(lpConsoleScreenBufferInfo))
; hConsoleOutput : HANDLE -> "sptr"
; lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetConsoleScreenBufferInfo(HANDLE hConsoleOutput, CONSOLE_SCREEN_BUFFER_INFO* lpConsoleScreenBufferInfo)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleScreenBufferInfo "GetConsoleScreenBufferInfo" intptr, var
; res = GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)
; hConsoleOutput : HANDLE -> "intptr"
; lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetConsoleScreenBufferInfo(HANDLE hConsoleOutput, CONSOLE_SCREEN_BUFFER_INFO* lpConsoleScreenBufferInfo)
#uselib "KERNEL32.dll"
#cfunc global GetConsoleScreenBufferInfo "GetConsoleScreenBufferInfo" intptr, intptr
; res = GetConsoleScreenBufferInfo(hConsoleOutput, varptr(lpConsoleScreenBufferInfo))
; hConsoleOutput : HANDLE -> "intptr"
; lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetConsoleScreenBufferInfo = kernel32.NewProc("GetConsoleScreenBufferInfo")
)

// hConsoleOutput (HANDLE), lpConsoleScreenBufferInfo (CONSOLE_SCREEN_BUFFER_INFO* out)
r1, _, err := procGetConsoleScreenBufferInfo.Call(
	uintptr(hConsoleOutput),
	uintptr(lpConsoleScreenBufferInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetConsoleScreenBufferInfo(
  hConsoleOutput: THandle;   // HANDLE
  lpConsoleScreenBufferInfo: Pointer   // CONSOLE_SCREEN_BUFFER_INFO* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetConsoleScreenBufferInfo';

result := DllCall("KERNEL32\GetConsoleScreenBufferInfo"
    , "Ptr", hConsoleOutput   ; HANDLE
    , "Ptr", lpConsoleScreenBufferInfo   ; CONSOLE_SCREEN_BUFFER_INFO* out
    , "Int")   ; return: BOOL

●GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo) = DLL("KERNEL32.dll", "bool GetConsoleScreenBufferInfo(void*, void*)")
# 呼び出し: GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)
# hConsoleOutput : HANDLE -> "void*"
# lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。