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

ScrollConsoleScreenBufferA

関数
コンソール画面バッファ内の矩形領域をスクロール移動する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
hConsoleOutputHANDLEin対象のコンソール画面バッファのハンドル。
lpScrollRectangleSMALL_RECT*inスクロール対象とする矩形範囲を示すSMALL_RECT構造体へのポインタ。
lpClipRectangleSMALL_RECT*inoptional書き換えを制限するクリップ矩形へのポインタ。NULL可で制限なし。
dwDestinationOriginCOORDinスクロール後の矩形左上の移動先座標を示すCOORD値。
lpFillCHAR_INFO*inスクロールで空いた領域を埋める文字と属性を示すCHAR_INFO構造体へのポインタ。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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)。
const std = @import("std");

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

typedef ScrollConsoleScreenBufferANative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, COORD, Pointer<Void>);
typedef ScrollConsoleScreenBufferADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final ScrollConsoleScreenBufferA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ScrollConsoleScreenBufferANative, ScrollConsoleScreenBufferADart>('ScrollConsoleScreenBufferA');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpScrollRectangle : SMALL_RECT* -> Pointer<Void>
// lpClipRectangle : SMALL_RECT* optional -> Pointer<Void>
// dwDestinationOrigin : COORD -> COORD
// lpFill : CHAR_INFO* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ScrollConsoleScreenBufferA"
  c_ScrollConsoleScreenBufferA :: Ptr () -> Ptr () -> Ptr () -> COORD -> Ptr () -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- lpScrollRectangle : SMALL_RECT* -> Ptr ()
-- lpClipRectangle : SMALL_RECT* optional -> Ptr ()
-- dwDestinationOrigin : COORD -> COORD
-- lpFill : CHAR_INFO* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let scrollconsolescreenbuffera =
  foreign "ScrollConsoleScreenBufferA"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> COORD @-> (ptr void) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpScrollRectangle : SMALL_RECT* -> (ptr void) *)
(* lpClipRectangle : SMALL_RECT* optional -> (ptr void) *)
(* dwDestinationOrigin : COORD -> COORD *)
(* lpFill : CHAR_INFO* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ScrollConsoleScreenBufferA" scroll-console-screen-buffer-a :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (lp-scroll-rectangle :pointer)   ; SMALL_RECT*
  (lp-clip-rectangle :pointer)   ; SMALL_RECT* optional
  (dw-destination-origin (:struct coord))   ; COORD
  (lp-fill :pointer))   ; CHAR_INFO*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ScrollConsoleScreenBufferA = Win32::API::More->new('KERNEL32',
    'BOOL ScrollConsoleScreenBufferA(HANDLE hConsoleOutput, LPVOID lpScrollRectangle, LPVOID lpClipRectangle, LPVOID dwDestinationOrigin, LPVOID lpFill)');
# my $ret = $ScrollConsoleScreenBufferA->Call($hConsoleOutput, $lpScrollRectangle, $lpClipRectangle, $dwDestinationOrigin, $lpFill);
# hConsoleOutput : HANDLE -> HANDLE
# lpScrollRectangle : SMALL_RECT* -> LPVOID
# lpClipRectangle : SMALL_RECT* optional -> LPVOID
# dwDestinationOrigin : COORD -> LPVOID
# lpFill : CHAR_INFO* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型