ホーム › System.Console › GetConsoleScreenBufferInfo
GetConsoleScreenBufferInfo
関数コンソール画面バッファのサイズやカーソル位置などの情報を取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL GetConsoleScreenBufferInfo(
HANDLE hConsoleOutput,
CONSOLE_SCREEN_BUFFER_INFO* lpConsoleScreenBufferInfo
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hConsoleOutput | HANDLE | in | 対象のコンソール画面バッファのハンドル。 |
| lpConsoleScreenBufferInfo | CONSOLE_SCREEN_BUFFER_INFO* | out | バッファサイズ・カーソル位置・ウィンドウ範囲等を受け取るCONSOLE_SCREEN_BUFFER_INFO出力ポインタ。 |
戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 // BOOLfunction 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)。const std = @import("std");
extern "kernel32" fn GetConsoleScreenBufferInfo(
hConsoleOutput: ?*anyopaque, // HANDLE
lpConsoleScreenBufferInfo: [*c]CONSOLE_SCREEN_BUFFER_INFO // CONSOLE_SCREEN_BUFFER_INFO* out
) callconv(std.os.windows.WINAPI) i32;proc GetConsoleScreenBufferInfo(
hConsoleOutput: pointer, # HANDLE
lpConsoleScreenBufferInfo: ptr CONSOLE_SCREEN_BUFFER_INFO # CONSOLE_SCREEN_BUFFER_INFO* out
): int32 {.importc: "GetConsoleScreenBufferInfo", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int GetConsoleScreenBufferInfo(
void* hConsoleOutput, // HANDLE
CONSOLE_SCREEN_BUFFER_INFO* lpConsoleScreenBufferInfo // CONSOLE_SCREEN_BUFFER_INFO* out
);ccall((:GetConsoleScreenBufferInfo, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{CONSOLE_SCREEN_BUFFER_INFO}),
hConsoleOutput, lpConsoleScreenBufferInfo)
# hConsoleOutput : HANDLE -> Ptr{Cvoid}
# lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> Ptr{CONSOLE_SCREEN_BUFFER_INFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t GetConsoleScreenBufferInfo(
void* hConsoleOutput,
void* lpConsoleScreenBufferInfo);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)
-- hConsoleOutput : HANDLE
-- lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetConsoleScreenBufferInfo = lib.func('__stdcall', 'GetConsoleScreenBufferInfo', 'int32_t', ['void *', 'void *']);
// GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)
// hConsoleOutput : HANDLE -> 'void *'
// lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetConsoleScreenBufferInfo: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo)
// hConsoleOutput : HANDLE -> "pointer"
// lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetConsoleScreenBufferInfo(
void* hConsoleOutput,
void* lpConsoleScreenBufferInfo);
C, "KERNEL32.dll");
// $ffi->GetConsoleScreenBufferInfo(hConsoleOutput, lpConsoleScreenBufferInfo);
// hConsoleOutput : HANDLE
// lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* 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 GetConsoleScreenBufferInfo(
Pointer hConsoleOutput, // HANDLE
Pointer lpConsoleScreenBufferInfo // CONSOLE_SCREEN_BUFFER_INFO* out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun GetConsoleScreenBufferInfo = GetConsoleScreenBufferInfo(
hConsoleOutput : Void*, # HANDLE
lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* # CONSOLE_SCREEN_BUFFER_INFO* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetConsoleScreenBufferInfoNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetConsoleScreenBufferInfoDart = int Function(Pointer<Void>, Pointer<Void>);
final GetConsoleScreenBufferInfo = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetConsoleScreenBufferInfoNative, GetConsoleScreenBufferInfoDart>('GetConsoleScreenBufferInfo');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetConsoleScreenBufferInfo(
hConsoleOutput: THandle; // HANDLE
lpConsoleScreenBufferInfo: Pointer // CONSOLE_SCREEN_BUFFER_INFO* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'GetConsoleScreenBufferInfo';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetConsoleScreenBufferInfo"
c_GetConsoleScreenBufferInfo :: Ptr () -> Ptr () -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getconsolescreenbufferinfo =
foreign "GetConsoleScreenBufferInfo"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* 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 ("GetConsoleScreenBufferInfo" get-console-screen-buffer-info :convention :stdcall) :int32
(h-console-output :pointer) ; HANDLE
(lp-console-screen-buffer-info :pointer)) ; CONSOLE_SCREEN_BUFFER_INFO* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetConsoleScreenBufferInfo = Win32::API::More->new('KERNEL32',
'BOOL GetConsoleScreenBufferInfo(HANDLE hConsoleOutput, LPVOID lpConsoleScreenBufferInfo)');
# my $ret = $GetConsoleScreenBufferInfo->Call($hConsoleOutput, $lpConsoleScreenBufferInfo);
# hConsoleOutput : HANDLE -> HANDLE
# lpConsoleScreenBufferInfo : CONSOLE_SCREEN_BUFFER_INFO* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
類似 API
- f GetConsoleScreenBufferInfoEx — コンソール画面バッファの拡張情報を取得する。