ホーム › UI.WindowsAndMessaging › ScrollWindow

ScrollWindow

関数

ウィンドウのクライアント領域の内容をスクロールする。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL ScrollWindow(
    HWND hWnd,
    INT XAmount,
    INT YAmount,
    const RECT* lpRect,   // optional
    const RECT* lpClipRect   // optional
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	クライアント領域をスクロールするウィンドウのハンドルです。
XAmount	INT	in	水平方向のスクロール量をデバイス単位で指定します。スクロール対象のウィンドウが CS_OWNDC または CS_CLASSDC スタイルを持つ場合、このパラメーターはデバイス単位ではなく論理単位を使用します。ウィンドウの内容を左方向にスクロールするには、このパラメーターを負の値にする必要があります。
YAmount	INT	in	垂直方向のスクロール量をデバイス単位で指定します。スクロール対象のウィンドウが CS_OWNDC または CS_CLASSDC スタイルを持つ場合、このパラメーターはデバイス単位ではなく論理単位を使用します。ウィンドウの内容を上方向にスクロールするには、このパラメーターを負の値にする必要があります。
lpRect	RECT*	inoptional	スクロールするクライアント領域の範囲を指定する RECT 構造体へのポインターです。このパラメーターが NULL の場合、クライアント領域全体がスクロールされます。
lpClipRect	RECT*	inoptional	クリッピング矩形の座標を含む RECT 構造体へのポインターです。クリッピング矩形内のデバイスビットのみが影響を受けます。矩形の外側から内側へスクロールされたビットは描画されますが、矩形の内側から外側へスクロールされたビットは描画されません。

戻り値の型: BOOL

公式ドキュメント

ScrollWindow 関数は、指定したウィンドウのクライアント領域の内容をスクロールします。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

スクロール対象のウィンドウ内にキャレットがある場合、ScrollWindow はキャレットが消去されるのを防ぐために自動的にキャレットを非表示にし、スクロール完了後にキャレットを復元します。キャレットの位置はそれに応じて調整されます。

ScrollWindow によって露出された領域は再描画されませんが、ウィンドウの更新領域に統合されます。アプリケーションは最終的に WM_PAINT メッセージを受け取り、その領域を再描画する必要があることが通知されます。スクロールの実行と同時に露出された領域を再描画するには、ScrollWindow を呼び出した直後に UpdateWindow 関数を呼び出します。

lpRect パラメーターが NULL の場合、ウィンドウ内のすべての子ウィンドウの位置は XAmount および YAmount パラメーターで指定された量だけオフセットされ、ウィンドウ内の無効な (未描画の) 領域もオフセットされます。lpRect が NULL のとき、ScrollWindow はより高速に動作します。

lpRect が NULL でない場合、子ウィンドウの位置は変更されず、ウィンドウ内の無効な領域もオフセットされません。lpRect が NULL でないときの更新の問題を防ぐには、ScrollWindow を呼び出す前に UpdateWindow を呼び出してウィンドウを再描画します。

例

例については、WM_PAINT メッセージによるテキストのスクロールを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL ScrollWindow(
    HWND hWnd,
    INT XAmount,
    INT YAmount,
    const RECT* lpRect,   // optional
    const RECT* lpClipRect   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ScrollWindow(
    IntPtr hWnd,   // HWND
    int XAmount,   // INT
    int YAmount,   // INT
    IntPtr lpRect,   // RECT* optional
    IntPtr lpClipRect   // RECT* optional
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ScrollWindow(
    hWnd As IntPtr,   ' HWND
    XAmount As Integer,   ' INT
    YAmount As Integer,   ' INT
    lpRect As IntPtr,   ' RECT* optional
    lpClipRect As IntPtr   ' RECT* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hWnd : HWND
' XAmount : INT
' YAmount : INT
' lpRect : RECT* optional
' lpClipRect : RECT* optional
Declare PtrSafe Function ScrollWindow Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal XAmount As Long, _
    ByVal YAmount As Long, _
    ByVal lpRect As LongPtr, _
    ByVal lpClipRect As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScrollWindow = ctypes.windll.user32.ScrollWindow
ScrollWindow.restype = wintypes.BOOL
ScrollWindow.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_int,  # XAmount : INT
    ctypes.c_int,  # YAmount : INT
    ctypes.c_void_p,  # lpRect : RECT* optional
    ctypes.c_void_p,  # lpClipRect : RECT* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ScrollWindow = Fiddle::Function.new(
  lib['ScrollWindow'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # XAmount : INT
    Fiddle::TYPE_INT,  # YAmount : INT
    Fiddle::TYPE_VOIDP,  # lpRect : RECT* optional
    Fiddle::TYPE_VOIDP,  # lpClipRect : RECT* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn ScrollWindow(
        hWnd: *mut core::ffi::c_void,  // HWND
        XAmount: i32,  // INT
        YAmount: i32,  // INT
        lpRect: *const RECT,  // RECT* optional
        lpClipRect: *const RECT  // RECT* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool ScrollWindow(IntPtr hWnd, int XAmount, int YAmount, IntPtr lpRect, IntPtr lpClipRect);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ScrollWindow' -Namespace Win32 -PassThru
# $api::ScrollWindow(hWnd, XAmount, YAmount, lpRect, lpClipRect)

#uselib "USER32.dll"
#func global ScrollWindow "ScrollWindow" sptr, sptr, sptr, sptr, sptr
; ScrollWindow hWnd, XAmount, YAmount, varptr(lpRect), varptr(lpClipRect)   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; XAmount : INT -> "sptr"
; YAmount : INT -> "sptr"
; lpRect : RECT* optional -> "sptr"
; lpClipRect : RECT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global ScrollWindow "ScrollWindow" sptr, int, int, var, var
; res = ScrollWindow(hWnd, XAmount, YAmount, lpRect, lpClipRect)
; hWnd : HWND -> "sptr"
; XAmount : INT -> "int"
; YAmount : INT -> "int"
; lpRect : RECT* optional -> "var"
; lpClipRect : RECT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global ScrollWindow "ScrollWindow" sptr, int, int, sptr, sptr
; res = ScrollWindow(hWnd, XAmount, YAmount, varptr(lpRect), varptr(lpClipRect))
; hWnd : HWND -> "sptr"
; XAmount : INT -> "int"
; YAmount : INT -> "int"
; lpRect : RECT* optional -> "sptr"
; lpClipRect : RECT* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。