CWnd::SetScrollInfo

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

更新 : 2007 年 11 月

スクロールバーに関して SCROLLINFO 構造体が保持する情報を設定します。

BOOL SetScrollInfo(
   int nBar,
   LPSCROLLINFO lpScrollInfo,
   BOOL bRedraw = TRUE 
);

パラメータ

nBar
スクロールバーがコントロールなのか、またはウィンドウの非クライアント領域の一部なのかを指定します。非クライアント領域の一部である場合は、nBar に、スクロールバーの配置を水平、垂直、またはその両方向にするかどうか指定します。次のいずれかの値を使用します。
- SB_CTL スクロールバーコントロールのパラメータを保持しています。m_hWnd データメンバはスクロールバーコントロールのハンドルである必要があります。
- SB_HORZ ウィンドウが水平スクロールバーであることを指定します。
- SB_VERT ウィンドウが垂直スクロールバーであることを指定します。
lpScrollInfo
SCROLLINFO 構造体へのポインタ。この構造体の詳細については、Windows SDK を参照してください。
bRedraw
新しい位置を反映するためにスクロールバーを再描画するかどうかを指定します。bRedraw が TRUE の場合、スクロールバーは再描画されます。FALSE の場合は、再描画されません。既定では、スクロールバーは再描画されます。

戻り値

正常終了した場合は TRUE を返します。それ以外の場合は、FALSE を返します。

解説

SCROLLINFO 構造体は、最小と最大のスクロール位置、ページサイズ、スクロールボックス (つまみ) の位置などのスクロールバーの情報を保持します。この構造体の既定値の変更の詳細については、Windows SDK の SCROLLINFO 構造体を参照してください。

スクロールバーの位置を示す MFC Windows メッセージハンドラである CWnd::OnHScroll と CWnd::OnVScroll は、16 ビットのみの位置データを提供します。CWnd::GetScrollInfo と SetScrollInfo は、32 ビットのスクロールバーの位置データを提供します。したがって、アプリケーションは CWnd::OnHScroll または CWnd::OnVScroll の処理中でも、GetScrollInfo を呼び出して 32 ビットのスクロールバーの位置データを取得できます。