ホーム › UI.WindowsAndMessaging › GetScrollBarInfo

GetScrollBarInfo

関数

指定ウィンドウのスクロールバー情報を取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// USER32.dll
#include <windows.h>

BOOL GetScrollBarInfo(
    HWND hwnd,
    OBJECT_IDENTIFIER idObject,
    SCROLLBARINFO* psbi
);

パラメーター

名前

型

方向

説明

hwnd

HWND

情報を取得するスクロールバーに関連付けられたウィンドウのハンドルです。idObject パラメーターが OBJID_CLIENT の場合、hwnd はスクロールバーコントロールのハンドルです。それ以外の場合、hwnd は WS_VSCROLL または WS_HSCROLL スタイル(あるいはその両方)で作成されたウィンドウのハンドルです。

idObject

OBJECT_IDENTIFIER

スクロールバーオブジェクトを指定します。このパラメーターには、次のいずれかの値を指定できます。

値	意味
OBJID_CLIENT	hwnd パラメーターはスクロールバーコントロールのハンドルです。
OBJID_HSCROLL	hwnd ウィンドウの水平スクロールバーです。
OBJID_VSCROLL	hwnd ウィンドウの垂直スクロールバーです。

psbi

SCROLLBARINFO*

inout

情報を受け取る SCROLLBARINFO 構造体へのポインターです。GetScrollBarInfo を呼び出す前に、cbSize メンバーに sizeof(SCROLLBARINFO) を設定してください。

戻り値の型: BOOL

公式ドキュメント

GetScrollBarInfo 関数は、指定したスクロールバーに関する情報を取得します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

idObject が OBJID_CLIENT であり、hwnd で指定されたウィンドウがシステムのスクロールバーコントロールでない場合、システムはスクロールバー情報を取得するために、そのウィンドウへ SBM_GETSCROLLBARINFO メッセージを送信します。これにより、GetScrollBarInfo はスクロールバーを模倣するカスタムコントロールに対しても動作できます。ウィンドウが SBM_GETSCROLLBARINFO メッセージを処理しない場合、GetScrollBarInfo 関数は失敗します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

BOOL GetScrollBarInfo(
    HWND hwnd,
    OBJECT_IDENTIFIER idObject,
    SCROLLBARINFO* psbi
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetScrollBarInfo(
    IntPtr hwnd,   // HWND
    int idObject,   // OBJECT_IDENTIFIER
    IntPtr psbi   // SCROLLBARINFO* in/out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetScrollBarInfo(
    hwnd As IntPtr,   ' HWND
    idObject As Integer,   ' OBJECT_IDENTIFIER
    psbi As IntPtr   ' SCROLLBARINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwnd : HWND
' idObject : OBJECT_IDENTIFIER
' psbi : SCROLLBARINFO* in/out
Declare PtrSafe Function GetScrollBarInfo Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal idObject As Long, _
    ByVal psbi As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetScrollBarInfo = ctypes.windll.user32.GetScrollBarInfo
GetScrollBarInfo.restype = wintypes.BOOL
GetScrollBarInfo.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_int,  # idObject : OBJECT_IDENTIFIER
    ctypes.c_void_p,  # psbi : SCROLLBARINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetScrollBarInfo = Fiddle::Function.new(
  lib['GetScrollBarInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_INT,  # idObject : OBJECT_IDENTIFIER
    Fiddle::TYPE_VOIDP,  # psbi : SCROLLBARINFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetScrollBarInfo(
        hwnd: *mut core::ffi::c_void,  // HWND
        idObject: i32,  // OBJECT_IDENTIFIER
        psbi: *mut SCROLLBARINFO  // SCROLLBARINFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetScrollBarInfo(IntPtr hwnd, int idObject, IntPtr psbi);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetScrollBarInfo' -Namespace Win32 -PassThru
# $api::GetScrollBarInfo(hwnd, idObject, psbi)

#uselib "USER32.dll"
#func global GetScrollBarInfo "GetScrollBarInfo" sptr, sptr, sptr
; GetScrollBarInfo hwnd, idObject, varptr(psbi)   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; idObject : OBJECT_IDENTIFIER -> "sptr"
; psbi : SCROLLBARINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetScrollBarInfo "GetScrollBarInfo" sptr, int, var
; res = GetScrollBarInfo(hwnd, idObject, psbi)
; hwnd : HWND -> "sptr"
; idObject : OBJECT_IDENTIFIER -> "int"
; psbi : SCROLLBARINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetScrollBarInfo "GetScrollBarInfo" sptr, int, sptr
; res = GetScrollBarInfo(hwnd, idObject, varptr(psbi))
; hwnd : HWND -> "sptr"
; idObject : OBJECT_IDENTIFIER -> "int"
; psbi : SCROLLBARINFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。