ホーム › UI.WindowsAndMessaging › GetScrollInfo

GetScrollInfo

関数

スクロールバーの位置や範囲などの情報を取得する。

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

シグネチャ

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

BOOL GetScrollInfo(
    HWND hwnd,
    SCROLLBAR_CONSTANTS nBar,
    SCROLLINFO* lpsi
);

パラメーター

名前

型

方向

説明

hwnd

HWND

fnBar パラメーターの値に応じて、スクロールバーコントロールへのハンドル、または標準スクロールバーを持つウィンドウへのハンドルを指定します。

nBar

SCROLLBAR_CONSTANTS

パラメーターを取得するスクロールバーの種類を指定します。このパラメーターには、次のいずれかの値を指定できます。

値	意味
SB_CTL	スクロールバーコントロールのパラメーターを取得します。hwnd パラメーターは、スクロールバーコントロールへのハンドルである必要があります。
SB_HORZ	ウィンドウの標準的な水平スクロールバーのパラメーターを取得します。
SB_VERT	ウィンドウの標準的な垂直スクロールバーのパラメーターを取得します。

lpsi

SCROLLINFO*

inout

SCROLLINFO 構造体へのポインター。GetScrollInfo を呼び出す前に、cbSize メンバーに sizeof(SCROLLINFO) を設定し、fMask メンバーに取得するスクロールバーのパラメーターを指定します。関数は戻る前に、指定されたパラメーターを構造体の該当するメンバーにコピーします。

fMask メンバーには、次の値を1つ以上指定できます。

値	意味
SIF_PAGE	スクロールページを、lpsi が指す SCROLLINFO 構造体の nPage メンバーにコピーします。
SIF_POS	スクロール位置を、lpsi が指す SCROLLINFO 構造体の nPos メンバーにコピーします。
SIF_RANGE	スクロール範囲を、lpsi が指す SCROLLINFO 構造体の nMin および nMax メンバーにコピーします。
SIF_TRACKPOS	現在のスクロールボックスの追跡位置を、lpsi が指す SCROLLINFO 構造体の nTrackPos メンバーにコピーします。

戻り値の型: BOOL

公式ドキュメント

GetScrollInfo 関数は、スクロールバーのパラメーター(スクロール位置の最小値と最大値、ページサイズ、スクロールボックス(つまみ)の位置を含む)を取得します。

戻り値

型: BOOL

関数が何らかの値を取得した場合、戻り値は 0 以外です。

関数が値を取得しなかった場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

GetScrollInfo 関数を使用すると、アプリケーションは 32 ビットのスクロール位置を利用できます。スクロールバーの位置を示すメッセージである WM_HSCROLL と WM_VSCROLL は 16 ビットの位置データしか提供しませんが、SetScrollInfo および GetScrollInfo 関数は 32 ビットのスクロールバー位置データを提供します。したがって、アプリケーションは WM_HSCROLL または WM_VSCROLL メッセージの処理中に GetScrollInfo を呼び出して、32 ビットのスクロールバー位置データを取得できます。

WM_HSCROLL または WM_VSCROLL メッセージの SB_THUMBTRACK 要求コードの処理中にスクロールボックス(つまみ)の 32 ビット位置を取得するには、SCROLLINFO 構造体の fMask メンバーに SIF_TRACKPOS 値を指定して GetScrollInfo を呼び出します。関数は、スクロールボックスの追跡位置を SCROLLINFO 構造体の nTrackPos メンバーで返します。これにより、ユーザーがスクロールボックスを移動している間にその位置を取得できます。次のサンプルコードはこの手法を示しています。

SCROLLINFO si;
case WM_HSCROLL:
    switch(LOWORD(wparam)) {
        case SB_THUMBTRACK:
          // Initialize SCROLLINFO structure
 
            ZeroMemory(&si, sizeof(si));
            si.cbSize = sizeof(si);
            si.fMask = SIF_TRACKPOS;
 
          // Call GetScrollInfo to get current tracking 
          //    position in si.nTrackPos
 
            if (!GetScrollInfo(hwnd, SB_HORZ, &si) )
                return 1; // GetScrollInfo failed
            break;
        .
        .
        .
    }

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

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

各言語での呼び出し定義

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

BOOL GetScrollInfo(
    HWND hwnd,
    SCROLLBAR_CONSTANTS nBar,
    SCROLLINFO* lpsi
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetScrollInfo(
    IntPtr hwnd,   // HWND
    int nBar,   // SCROLLBAR_CONSTANTS
    IntPtr lpsi   // SCROLLINFO* in/out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetScrollInfo(
    hwnd As IntPtr,   ' HWND
    nBar As Integer,   ' SCROLLBAR_CONSTANTS
    lpsi As IntPtr   ' SCROLLINFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hwnd : HWND
' nBar : SCROLLBAR_CONSTANTS
' lpsi : SCROLLINFO* in/out
Declare PtrSafe Function GetScrollInfo Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal nBar As Long, _
    ByVal lpsi As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetScrollInfo = ctypes.windll.user32.GetScrollInfo
GetScrollInfo.restype = wintypes.BOOL
GetScrollInfo.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_int,  # nBar : SCROLLBAR_CONSTANTS
    ctypes.c_void_p,  # lpsi : SCROLLINFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetScrollInfo = Fiddle::Function.new(
  lib['GetScrollInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_INT,  # nBar : SCROLLBAR_CONSTANTS
    Fiddle::TYPE_VOIDP,  # lpsi : SCROLLINFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetScrollInfo(
        hwnd: *mut core::ffi::c_void,  // HWND
        nBar: i32,  // SCROLLBAR_CONSTANTS
        lpsi: *mut SCROLLINFO  // SCROLLINFO* 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 GetScrollInfo(IntPtr hwnd, int nBar, IntPtr lpsi);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetScrollInfo' -Namespace Win32 -PassThru
# $api::GetScrollInfo(hwnd, nBar, lpsi)

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

出力引数:

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