CScrollBar::GetScrollInfo

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

更新 : 2007 年 11 月

SCROLLINFO 構造体がスクロールバーについて保持する情報を取得します。

BOOL GetScrollInfo(
   LPSCROLLINFO lpScrollInfo,
   UINT nMask = SIF_ALL 
);

パラメータ

lpScrollInfo
SCROLLINFO 構造体へのポインタ。この構造体の詳細については、Windows SDK を参照してください。
nMask
取得するスクロールバーのパラメータを指定します。代表的な SIF_ALL の使用では、SIF_PAGE、SIF_POS、SIF_TRACKPOS、SIF_RANGE を組み合わせます。nMask の値の詳細については、「SCROLLINFO」を参照してください。

戻り値

スクロールバー情報を取得した場合は、TRUE を返します。それ以外の場合は、FALSE を返します。

解説

GetScrollInfo では、32 ビットのスクロール位置を使用できるようにします。

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

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