SetScrollInfo

関数

スクロールバーの位置・範囲・ページサイズなどの情報を設定する。

DLLUSER32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT SetScrollInfo(
    HWND hwnd,
    SCROLLBAR_CONSTANTS nBar,
    SCROLLINFO* lpsi,
    BOOL redraw
);

パラメーター

名前

型

方向

説明

hwnd

HWND

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

nBar

SCROLLBAR_CONSTANTS

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

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

lpsi

SCROLLINFO*

SCROLLINFO 構造体へのポインターです。SetScrollInfo を呼び出す前に、構造体の cbSize メンバーに sizeof(SCROLLINFO) を設定し、設定するパラメーターを示すために fMask メンバーを設定して、該当するメンバーに新しいパラメーター値を指定します。

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

値	意味
SIF_DISABLENOSCROLL	スクロールバーの新しいパラメーターによってスクロールバーが不要になる場合に、スクロールバーを削除する代わりに無効化します。
SIF_PAGE	lpsi が指す SCROLLINFO 構造体の nPage メンバーで指定された値に、スクロールページを設定します。
SIF_POS	lpsi が指す SCROLLINFO 構造体の nPos メンバーで指定された値に、スクロール位置を設定します。
SIF_RANGE	lpsi が指す SCROLLINFO 構造体の nMin および nMax メンバーで指定された値に、スクロール範囲を設定します。

redraw

BOOL

スクロールバーの変更を反映するためにスクロールバーを再描画するかどうかを指定します。このパラメーターが TRUE の場合はスクロールバーが再描画され、そうでない場合は再描画されません。

戻り値の型: INT

公式ドキュメント

SetScrollInfo 関数は、スクロールの最小位置と最大位置、ページサイズ、スクロールボックス(つまみ)の位置など、スクロールバーのパラメーターを設定します。要求された場合、この関数はスクロールバーの再描画も行います。

戻り値

型: int

戻り値は、スクロールボックスの現在の位置です。

解説(Remarks)

SetScrollInfo 関数は、SCROLLINFO 構造体の nPage および nPos メンバーで指定された値に対して範囲チェックを行います。nPage メンバーには、0 から nMax - nMin + 1 までの値を指定する必要があります。nPos メンバーには、nMin から nMax - max(nPage – 1, 0) までの値を指定する必要があります。いずれかの値が範囲外の場合、関数はその値を範囲内に収まる直近の値に設定します。

fnBar パラメーターが SB_CTL で、hwnd パラメーターで指定されたウィンドウがシステムのスクロールバーコントロールでない場合、システムはスクロールバー情報を設定するために、そのウィンドウへ SBM_SETSCROLLINFO メッセージを送信します(要求が位置または範囲のみに関するものである場合、システムはメッセージを SBM_SETPOS または SBM_SETRANGE に最適化できます)。これにより、SetScrollInfo はスクロールバーを模倣するカスタムコントロールに対して動作できます。ウィンドウが SBM_SETSCROLLINFO(または最適化された SBM_SETPOS メッセージや SBM_SETRANGE メッセージ)を処理しない場合、SetScrollInfo 関数は失敗します。

例については、WM_PAINT メッセージによるテキストのスクロールを参照してください。

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

各言語での呼び出し定義

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

INT SetScrollInfo(
    HWND hwnd,
    SCROLLBAR_CONSTANTS nBar,
    SCROLLINFO* lpsi,
    BOOL redraw
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern int SetScrollInfo(
    IntPtr hwnd,   // HWND
    int nBar,   // SCROLLBAR_CONSTANTS
    IntPtr lpsi,   // SCROLLINFO*
    bool redraw   // BOOL
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function SetScrollInfo(
    hwnd As IntPtr,   ' HWND
    nBar As Integer,   ' SCROLLBAR_CONSTANTS
    lpsi As IntPtr,   ' SCROLLINFO*
    redraw As Boolean   ' BOOL
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

SetScrollInfo = ctypes.windll.user32.SetScrollInfo
SetScrollInfo.restype = ctypes.c_int
SetScrollInfo.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_int,  # nBar : SCROLLBAR_CONSTANTS
    ctypes.c_void_p,  # lpsi : SCROLLINFO*
    wintypes.BOOL,  # redraw : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetScrollInfo = Fiddle::Function.new(
  lib['SetScrollInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_INT,  # nBar : SCROLLBAR_CONSTANTS
    Fiddle::TYPE_VOIDP,  # lpsi : SCROLLINFO*
    Fiddle::TYPE_INT,  # redraw : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn SetScrollInfo(
        hwnd: *mut core::ffi::c_void,  // HWND
        nBar: i32,  // SCROLLBAR_CONSTANTS
        lpsi: *mut SCROLLINFO,  // SCROLLINFO*
        redraw: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern int SetScrollInfo(IntPtr hwnd, int nBar, IntPtr lpsi, bool redraw);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetScrollInfo' -Namespace Win32 -PassThru
# $api::SetScrollInfo(hwnd, nBar, lpsi, redraw)

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

出力引数:

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