CDC::ScrollDC

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

ビットで構成された四角形を水平方向と垂直方向にスクロールします。

BOOL ScrollDC(
   int dx,
   int dy,
   LPCRECT lpRectScroll,
   LPCRECT lpRectClip,
   CRgn* pRgnUpdate,
   LPRECT lpRectUpdate 
);

パラメータ

dx
水平方向へのスクロールの単位数を指定します。
dy
垂直方向へのスクロールの単位数を指定します。
lpRectScroll
スクロールされる四角形の座標を保持する RECT 構造体または CRect オブジェクトへのポインタ。
lpRectClip
クリッピング長方形の座標を保持する RECT 構造体または CRect オブジェクトへのポインタ。この四角形が lpRectScroll で指定される元の四角形よりも小さいときは、小さい四角形だけがスクロールされます。
pRgnUpdate
スクロールの結果生じた更新が必要な領域を識別します。ScrollDC 関数がこの領域を定義します。領域は四角形とは限りません。
lpRectUpdate
スクロールの結果生じた更新領域に外接する四角形の座標を受け取る RECT 構造体または CRect オブジェクトへのポインタ。これは、再描画を必要とする最大の四角形領域です。関数から返るとき、この構造体またはオブジェクトの値は、指定されたデバイスコンテキストのマップモードとは無関係に、クライアント座標で表現されます。

戻り値

スクロールされた場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

lpRectUpdate が NULL のときは、Windows は更新四角形は計算しません。pRgnUpdate と lpRectUpdate が共に NULL のときは、Windows は更新領域も計算しません。pRgnUpdate が NULL でないときは、Windows はスクロールの結果生じた更新領域への有効なポインタを持つと仮定します。領域は ScrollDC メンバ関数が定義します。lpRectUpdate に返される更新領域は、必要に応じて CWnd::InvalidateRgn に渡すことができます。

ウィンドウのクライアント領域の全体をスクロールする必要がある場合は、アプリケーションは CWnd クラスの ScrollWindow メンバ関数を使います。それ以外の場合は、ScrollDC を使います。