ホーム › System.Console › ScrollConsoleScreenBufferA

ScrollConsoleScreenBufferA

関数

コンソール画面バッファ内の矩形領域をスクロール移動する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL ScrollConsoleScreenBufferA(
    HANDLE hConsoleOutput,
    const SMALL_RECT* lpScrollRectangle,
    const SMALL_RECT* lpClipRectangle,   // optional
    COORD dwDestinationOrigin,
    const CHAR_INFO* lpFill
);

パラメーター

名前	型	方向
hConsoleOutput	HANDLE	in
lpScrollRectangle	SMALL_RECT*	in
lpClipRectangle	SMALL_RECT*	inoptional
dwDestinationOrigin	COORD	in
lpFill	CHAR_INFO*	in

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL ScrollConsoleScreenBufferA(
    HANDLE hConsoleOutput,
    const SMALL_RECT* lpScrollRectangle,
    const SMALL_RECT* lpClipRectangle,   // optional
    COORD dwDestinationOrigin,
    const CHAR_INFO* lpFill
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ScrollConsoleScreenBufferA(
    IntPtr hConsoleOutput,   // HANDLE
    IntPtr lpScrollRectangle,   // SMALL_RECT*
    IntPtr lpClipRectangle,   // SMALL_RECT* optional
    COORD dwDestinationOrigin,   // COORD
    IntPtr lpFill   // CHAR_INFO*
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ScrollConsoleScreenBufferA(
    hConsoleOutput As IntPtr,   ' HANDLE
    lpScrollRectangle As IntPtr,   ' SMALL_RECT*
    lpClipRectangle As IntPtr,   ' SMALL_RECT* optional
    dwDestinationOrigin As COORD,   ' COORD
    lpFill As IntPtr   ' CHAR_INFO*
) As Boolean
End Function

' hConsoleOutput : HANDLE
' lpScrollRectangle : SMALL_RECT*
' lpClipRectangle : SMALL_RECT* optional
' dwDestinationOrigin : COORD
' lpFill : CHAR_INFO*
Declare PtrSafe Function ScrollConsoleScreenBufferA Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpScrollRectangle As LongPtr, _
    ByVal lpClipRectangle As LongPtr, _
    ByVal dwDestinationOrigin As LongPtr, _
    ByVal lpFill As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScrollConsoleScreenBufferA = ctypes.windll.kernel32.ScrollConsoleScreenBufferA
ScrollConsoleScreenBufferA.restype = wintypes.BOOL
ScrollConsoleScreenBufferA.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    ctypes.c_void_p,  # lpScrollRectangle : SMALL_RECT*
    ctypes.c_void_p,  # lpClipRectangle : SMALL_RECT* optional
    COORD,  # dwDestinationOrigin : COORD
    ctypes.c_void_p,  # lpFill : CHAR_INFO*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ScrollConsoleScreenBufferA = Fiddle::Function.new(
  lib['ScrollConsoleScreenBufferA'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpScrollRectangle : SMALL_RECT*
    Fiddle::TYPE_VOIDP,  # lpClipRectangle : SMALL_RECT* optional
    Fiddle::TYPE_VOIDP,  # dwDestinationOrigin : COORD
    Fiddle::TYPE_VOIDP,  # lpFill : CHAR_INFO*
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn ScrollConsoleScreenBufferA(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpScrollRectangle: *const SMALL_RECT,  // SMALL_RECT*
        lpClipRectangle: *const SMALL_RECT,  // SMALL_RECT* optional
        dwDestinationOrigin: COORD,  // COORD
        lpFill: *const CHAR_INFO  // CHAR_INFO*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool ScrollConsoleScreenBufferA(IntPtr hConsoleOutput, IntPtr lpScrollRectangle, IntPtr lpClipRectangle, COORD dwDestinationOrigin, IntPtr lpFill);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ScrollConsoleScreenBufferA' -Namespace Win32 -PassThru
# $api::ScrollConsoleScreenBufferA(hConsoleOutput, lpScrollRectangle, lpClipRectangle, dwDestinationOrigin, lpFill)

#uselib "KERNEL32.dll"
#func global ScrollConsoleScreenBufferA "ScrollConsoleScreenBufferA" sptr, sptr, sptr, sptr, sptr
; ScrollConsoleScreenBufferA hConsoleOutput, varptr(lpScrollRectangle), varptr(lpClipRectangle), dwDestinationOrigin, varptr(lpFill)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpScrollRectangle : SMALL_RECT* -> "sptr"
; lpClipRectangle : SMALL_RECT* optional -> "sptr"
; dwDestinationOrigin : COORD -> "sptr"
; lpFill : CHAR_INFO* -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global ScrollConsoleScreenBufferA "ScrollConsoleScreenBufferA" sptr, var, var, int, var
; res = ScrollConsoleScreenBufferA(hConsoleOutput, lpScrollRectangle, lpClipRectangle, dwDestinationOrigin, lpFill)
; hConsoleOutput : HANDLE -> "sptr"
; lpScrollRectangle : SMALL_RECT* -> "var"
; lpClipRectangle : SMALL_RECT* optional -> "var"
; dwDestinationOrigin : COORD -> "int"
; lpFill : CHAR_INFO* -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global ScrollConsoleScreenBufferA "ScrollConsoleScreenBufferA" sptr, sptr, sptr, int, sptr
; res = ScrollConsoleScreenBufferA(hConsoleOutput, varptr(lpScrollRectangle), varptr(lpClipRectangle), dwDestinationOrigin, varptr(lpFill))
; hConsoleOutput : HANDLE -> "sptr"
; lpScrollRectangle : SMALL_RECT* -> "sptr"
; lpClipRectangle : SMALL_RECT* optional -> "sptr"
; dwDestinationOrigin : COORD -> "int"
; lpFill : CHAR_INFO* -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL ScrollConsoleScreenBufferA(HANDLE hConsoleOutput, SMALL_RECT* lpScrollRectangle, SMALL_RECT* lpClipRectangle, COORD dwDestinationOrigin, CHAR_INFO* lpFill)
#uselib "KERNEL32.dll"
#cfunc global ScrollConsoleScreenBufferA "ScrollConsoleScreenBufferA" intptr, var, var, int, var
; res = ScrollConsoleScreenBufferA(hConsoleOutput, lpScrollRectangle, lpClipRectangle, dwDestinationOrigin, lpFill)
; hConsoleOutput : HANDLE -> "intptr"
; lpScrollRectangle : SMALL_RECT* -> "var"
; lpClipRectangle : SMALL_RECT* optional -> "var"
; dwDestinationOrigin : COORD -> "int"
; lpFill : CHAR_INFO* -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ScrollConsoleScreenBufferA(HANDLE hConsoleOutput, SMALL_RECT* lpScrollRectangle, SMALL_RECT* lpClipRectangle, COORD dwDestinationOrigin, CHAR_INFO* lpFill)
#uselib "KERNEL32.dll"
#cfunc global ScrollConsoleScreenBufferA "ScrollConsoleScreenBufferA" intptr, intptr, intptr, int, intptr
; res = ScrollConsoleScreenBufferA(hConsoleOutput, varptr(lpScrollRectangle), varptr(lpClipRectangle), dwDestinationOrigin, varptr(lpFill))
; hConsoleOutput : HANDLE -> "intptr"
; lpScrollRectangle : SMALL_RECT* -> "intptr"
; lpClipRectangle : SMALL_RECT* optional -> "intptr"
; dwDestinationOrigin : COORD -> "int"
; lpFill : CHAR_INFO* -> "intptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procScrollConsoleScreenBufferA = kernel32.NewProc("ScrollConsoleScreenBufferA")
)

// hConsoleOutput (HANDLE), lpScrollRectangle (SMALL_RECT*), lpClipRectangle (SMALL_RECT* optional), dwDestinationOrigin (COORD), lpFill (CHAR_INFO*)
r1, _, err := procScrollConsoleScreenBufferA.Call(
	uintptr(hConsoleOutput),
	uintptr(lpScrollRectangle),
	uintptr(lpClipRectangle),
	uintptr(dwDestinationOrigin),
	uintptr(lpFill),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function ScrollConsoleScreenBufferA(
  hConsoleOutput: THandle;   // HANDLE
  lpScrollRectangle: Pointer;   // SMALL_RECT*
  lpClipRectangle: Pointer;   // SMALL_RECT* optional
  dwDestinationOrigin: COORD;   // COORD
  lpFill: Pointer   // CHAR_INFO*
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ScrollConsoleScreenBufferA';

result := DllCall("KERNEL32\ScrollConsoleScreenBufferA"
    , "Ptr", hConsoleOutput   ; HANDLE
    , "Ptr", lpScrollRectangle   ; SMALL_RECT*
    , "Ptr", lpClipRectangle   ; SMALL_RECT* optional
    , "Ptr", dwDestinationOrigin   ; COORD
    , "Ptr", lpFill   ; CHAR_INFO*
    , "Int")   ; return: BOOL

●ScrollConsoleScreenBufferA(hConsoleOutput, lpScrollRectangle, lpClipRectangle, dwDestinationOrigin, lpFill) = DLL("KERNEL32.dll", "bool ScrollConsoleScreenBufferA(void*, void*, void*, void*, void*)")
# 呼び出し: ScrollConsoleScreenBufferA(hConsoleOutput, lpScrollRectangle, lpClipRectangle, dwDestinationOrigin, lpFill)
# hConsoleOutput : HANDLE -> "void*"
# lpScrollRectangle : SMALL_RECT* -> "void*"
# lpClipRectangle : SMALL_RECT* optional -> "void*"
# dwDestinationOrigin : COORD -> "void*"
# lpFill : CHAR_INFO* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。