ScrollDC

関数

デバイスコンテキスト内の矩形をスクロールする。

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

シグネチャ

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

BOOL ScrollDC(
    HDC hDC,
    INT dx,
    INT dy,
    const RECT* lprcScroll,   // optional
    const RECT* lprcClip,   // optional
    HRGN hrgnUpdate,   // optional
    RECT* lprcUpdate   // optional
);

パラメーター

名前	型	方向	説明
hDC	HDC	in	スクロール対象のビットを含むデバイスコンテキストのハンドルです。
dx	INT	in	水平方向のスクロール量をデバイス単位で指定します。左方向にスクロールするには、このパラメーターを負の値にする必要があります。
dy	INT	in	垂直方向のスクロール量をデバイス単位で指定します。上方向にスクロールするには、このパラメーターを負の値にする必要があります。
lprcScroll	RECT*	inoptional	スクロール対象のビットの座標を含む RECT 構造体へのポインターです。スクロール操作の影響を受けるのは、この矩形と lprcClip で指定された矩形との交差部分にあるビットのみです。lprcScroll が NULL の場合は、クライアント領域全体が使用されます。
lprcClip	RECT*	inoptional	クリッピング矩形の座標を含む RECT 構造体へのポインターです。描画されるのは、スクロール操作の完了後にこの矩形の内側に残るビットのみです。lprcClip が NULL の場合は、クライアント領域全体が使用されます。
hrgnUpdate	HRGN	inoptional	スクロール処理によって露出した領域のハンドルです。ScrollDC がこの領域を定義しますが、必ずしも矩形であるとは限りません。
lprcUpdate	RECT*	outoptional	スクロールにより再描画が必要となる更新領域を囲む矩形の座標を受け取る RECT 構造体へのポインターです。これは再描画が必要となる最大の矩形領域です。関数が戻るとき、構造体内の値は、指定されたデバイスコンテキストのマッピングモードに関係なくクライアント座標で表されます。これにより、アプリケーションは必要に応じてこの更新領域を InvalidateRgn 関数の呼び出しに使用できます。

戻り値の型: BOOL

公式ドキュメント

ScrollDC 関数は、ビットの矩形領域を水平方向および垂直方向にスクロールします。

戻り値

型: BOOL

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

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

解説(Remarks)

lprcUpdate パラメーターが NULL の場合、システムは更新矩形を計算しません。hrgnUpdate パラメーターと lprcUpdate パラメーターの両方が NULL の場合、システムは更新領域を計算しません。hrgnUpdate が NULL でない場合、システムは、スクロール処理によって露出した領域 (ScrollDC によって定義される) への有効なハンドルが含まれているものとして処理を進めます。

ウィンドウのクライアント領域全体をスクロールする必要がある場合は、ScrollWindowEx 関数を使用してください。

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

各言語での呼び出し定義

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

BOOL ScrollDC(
    HDC hDC,
    INT dx,
    INT dy,
    const RECT* lprcScroll,   // optional
    const RECT* lprcClip,   // optional
    HRGN hrgnUpdate,   // optional
    RECT* lprcUpdate   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ScrollDC(
    IntPtr hDC,   // HDC
    int dx,   // INT
    int dy,   // INT
    IntPtr lprcScroll,   // RECT* optional
    IntPtr lprcClip,   // RECT* optional
    IntPtr hrgnUpdate,   // HRGN optional
    IntPtr lprcUpdate   // RECT* optional, out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ScrollDC(
    hDC As IntPtr,   ' HDC
    dx As Integer,   ' INT
    dy As Integer,   ' INT
    lprcScroll As IntPtr,   ' RECT* optional
    lprcClip As IntPtr,   ' RECT* optional
    hrgnUpdate As IntPtr,   ' HRGN optional
    lprcUpdate As IntPtr   ' RECT* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hDC : HDC
' dx : INT
' dy : INT
' lprcScroll : RECT* optional
' lprcClip : RECT* optional
' hrgnUpdate : HRGN optional
' lprcUpdate : RECT* optional, out
Declare PtrSafe Function ScrollDC Lib "user32" ( _
    ByVal hDC As LongPtr, _
    ByVal dx As Long, _
    ByVal dy As Long, _
    ByVal lprcScroll As LongPtr, _
    ByVal lprcClip As LongPtr, _
    ByVal hrgnUpdate As LongPtr, _
    ByVal lprcUpdate As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScrollDC = ctypes.windll.user32.ScrollDC
ScrollDC.restype = wintypes.BOOL
ScrollDC.argtypes = [
    wintypes.HANDLE,  # hDC : HDC
    ctypes.c_int,  # dx : INT
    ctypes.c_int,  # dy : INT
    ctypes.c_void_p,  # lprcScroll : RECT* optional
    ctypes.c_void_p,  # lprcClip : RECT* optional
    wintypes.HANDLE,  # hrgnUpdate : HRGN optional
    ctypes.c_void_p,  # lprcUpdate : RECT* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
ScrollDC = Fiddle::Function.new(
  lib['ScrollDC'],
  [
    Fiddle::TYPE_VOIDP,  # hDC : HDC
    Fiddle::TYPE_INT,  # dx : INT
    Fiddle::TYPE_INT,  # dy : INT
    Fiddle::TYPE_VOIDP,  # lprcScroll : RECT* optional
    Fiddle::TYPE_VOIDP,  # lprcClip : RECT* optional
    Fiddle::TYPE_VOIDP,  # hrgnUpdate : HRGN optional
    Fiddle::TYPE_VOIDP,  # lprcUpdate : RECT* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn ScrollDC(
        hDC: *mut core::ffi::c_void,  // HDC
        dx: i32,  // INT
        dy: i32,  // INT
        lprcScroll: *const RECT,  // RECT* optional
        lprcClip: *const RECT,  // RECT* optional
        hrgnUpdate: *mut core::ffi::c_void,  // HRGN optional
        lprcUpdate: *mut RECT  // RECT* optional, out
    ) -> 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 ScrollDC(IntPtr hDC, int dx, int dy, IntPtr lprcScroll, IntPtr lprcClip, IntPtr hrgnUpdate, IntPtr lprcUpdate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ScrollDC' -Namespace Win32 -PassThru
# $api::ScrollDC(hDC, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate)

#uselib "USER32.dll"
#func global ScrollDC "ScrollDC" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ScrollDC hDC, dx, dy, varptr(lprcScroll), varptr(lprcClip), hrgnUpdate, varptr(lprcUpdate)   ; 戻り値は stat
; hDC : HDC -> "sptr"
; dx : INT -> "sptr"
; dy : INT -> "sptr"
; lprcScroll : RECT* optional -> "sptr"
; lprcClip : RECT* optional -> "sptr"
; hrgnUpdate : HRGN optional -> "sptr"
; lprcUpdate : RECT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global ScrollDC "ScrollDC" sptr, int, int, var, var, sptr, var
; res = ScrollDC(hDC, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate)
; hDC : HDC -> "sptr"
; dx : INT -> "int"
; dy : INT -> "int"
; lprcScroll : RECT* optional -> "var"
; lprcClip : RECT* optional -> "var"
; hrgnUpdate : HRGN optional -> "sptr"
; lprcUpdate : RECT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global ScrollDC "ScrollDC" sptr, int, int, sptr, sptr, sptr, sptr
; res = ScrollDC(hDC, dx, dy, varptr(lprcScroll), varptr(lprcClip), hrgnUpdate, varptr(lprcUpdate))
; hDC : HDC -> "sptr"
; dx : INT -> "int"
; dy : INT -> "int"
; lprcScroll : RECT* optional -> "sptr"
; lprcClip : RECT* optional -> "sptr"
; hrgnUpdate : HRGN optional -> "sptr"
; lprcUpdate : RECT* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。