ホーム › UI.WindowsAndMessaging › GetScrollRange

GetScrollRange

関数

スクロールバーの最小・最大位置の範囲を取得する。

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

シグネチャ

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

BOOL GetScrollRange(
    HWND hWnd,
    SCROLLBAR_CONSTANTS nBar,
    INT* lpMinPos,
    INT* lpMaxPos
);

パラメーター

名前

型

方向

説明

hWnd

HWND

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

nBar

SCROLLBAR_CONSTANTS

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

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

lpMinPos

INT*

out

最小位置を受け取る整数変数へのポインターです。

lpMaxPos

INT*

out

最大位置を受け取る整数変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

GetScrollRange 関数は、指定したスクロールバーの、現在のスクロールボックス (つまみ) の最小位置と最大位置を取得します。

戻り値

型: BOOL

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

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

解説(Remarks)

指定したウィンドウが標準スクロールバーを持たない場合、またはスクロールバーコントロールでない場合、GetScrollRange 関数は lpMinPos パラメーターと lpMaxPos パラメーターに 0 をコピーします。

標準スクロールバーの既定の範囲は 0 から 100 です。スクロールバーコントロールの既定の範囲は空です (両方の値が 0)。

スクロールバーの位置を示すメッセージ WM_HSCROLL と WM_VSCROLL は、位置データが 16 ビットに制限されています。ただし、SetScrollInfo、SetScrollPos、SetScrollRange、GetScrollInfo、GetScrollPos、および GetScrollRange は 32 ビットのスクロールバー位置データをサポートするため、WM_HSCROLL および WM_VSCROLL メッセージの 16 ビットの制限を回避する方法があります。その手法の説明については、GetScrollInfo 関数を参照してください。

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

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

各言語での呼び出し定義

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

BOOL GetScrollRange(
    HWND hWnd,
    SCROLLBAR_CONSTANTS nBar,
    INT* lpMinPos,
    INT* lpMaxPos
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetScrollRange(
    IntPtr hWnd,   // HWND
    int nBar,   // SCROLLBAR_CONSTANTS
    out int lpMinPos,   // INT* out
    out int lpMaxPos   // INT* out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetScrollRange(
    hWnd As IntPtr,   ' HWND
    nBar As Integer,   ' SCROLLBAR_CONSTANTS
    <Out> ByRef lpMinPos As Integer,   ' INT* out
    <Out> ByRef lpMaxPos As Integer   ' INT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hWnd : HWND
' nBar : SCROLLBAR_CONSTANTS
' lpMinPos : INT* out
' lpMaxPos : INT* out
Declare PtrSafe Function GetScrollRange Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal nBar As Long, _
    ByRef lpMinPos As Long, _
    ByRef lpMaxPos As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetScrollRange = ctypes.windll.user32.GetScrollRange
GetScrollRange.restype = wintypes.BOOL
GetScrollRange.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_int,  # nBar : SCROLLBAR_CONSTANTS
    ctypes.POINTER(ctypes.c_int),  # lpMinPos : INT* out
    ctypes.POINTER(ctypes.c_int),  # lpMaxPos : INT* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetScrollRange = Fiddle::Function.new(
  lib['GetScrollRange'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_INT,  # nBar : SCROLLBAR_CONSTANTS
    Fiddle::TYPE_VOIDP,  # lpMinPos : INT* out
    Fiddle::TYPE_VOIDP,  # lpMaxPos : INT* out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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