CWnd::GetScrollInfo

2011-08-09

更新 : 2010 年 12 月

スクロールバーに関して SCROLLINFO 構造体が保持する情報を取得するには、このメンバー関数を呼び出します。

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

パラメーター

nBar
スクロールバーがコントロールなのか、またはウィンドウの非クライアント領域の一部なのかを指定します。非クライアント領域の一部である場合は、スクロールバーが、水平、垂直、またはその両方向に置かれるかどうかを nBar に指定します。次のいずれかの値を使用します。
- SB_CTLスクロールバーコントロールのパラメーターを取得します。 m_hWnd データメンバーはスクロールバーコントロールのハンドルである必要があります。
- SB_HORZウィンドウの標準の水平スクロールバーのパラメーターを取得します。
- SB_VERTウィンドウの標準の垂直スクロールバーのパラメーターを取得します。
lpScrollInfo
SCROLLINFO 構造体へのポインター。この構造体の詳細については、Windows SDK を参照してください。
nMask
取得するスクロールバーのパラメーターを指定します。既定では、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 の処理中でも、GetScrollInfo を呼び出して 32 ビットのスクロールバーの位置データを取得できます。