GetScrollBarInfo 関数 (winuser.h)
GetScrollBarInfo 関数は、指定されたスクロール バーに関する情報を取得します。
構文
BOOL GetScrollBarInfo(
[in] HWND hwnd,
[in] LONG idObject,
[out] PSCROLLBARINFO psbi
);
パラメーター
[in] hwnd
種類: HWND
情報を取得するスクロール バーに関連付けられているウィンドウを処理します。 idObject パラメーターがOBJID_CLIENT場合、hwnd はスクロール バー コントロールへのハンドルです。 それ以外の場合、 hwnd は、 WS_VSCROLLまたはWS_HSCROLLスタイルで 作成されたウィンドウへのハンドルです。
[in] idObject
型: LONG
スクロール バー オブジェクトを指定します。 このパラメーターには、次の値のいずれかを指定できます。
値 | 意味 |
---|---|
|
hwnd パラメーターは、スクロール バー コントロールへのハンドルです。 |
|
hwnd ウィンドウの水平スクロール バー。 |
|
hwnd ウィンドウの垂直スクロール バー。 |
[out] psbi
種類: PSCROLLBARINFO
情報を受け取る SCROLLBARINFO 構造体へのポインター。 GetScrollBarInfo を呼び出す前に、cbSize メンバーを sizeof(SCROLLBARINFO) に設定します。
戻り値
種類: BOOL
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
idObject がOBJID_CLIENTされ、hwnd で指定されたウィンドウがシステム スクロール バー コントロールではない場合、システムはSBM_GETSCROLLBARINFO メッセージをウィンドウに送信してスクロール バー情報を取得します。 これにより、 GetScrollBarInfo は、スクロール バーを模倣するカスタム コントロールを操作できます。 ウィンドウで SBM_GETSCROLLBARINFO メッセージが処理されない場合、 GetScrollBarInfo 関数は失敗します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | winuser.h (Windows.h を含む) |
Library | User32.lib |
[DLL] | User32.dll |
再頒布可能パッケージ | Service Pack 6 |
API セット | ext-ms-win-ntuser-misc-l1-2-0 (Windows 8.1で導入) |