ホーム › UI.Controls › FlatSB_SetScrollInfo

FlatSB_SetScrollInfo

関数

フラットスクロールバーのスクロール情報を設定する。

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

シグネチャ

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

INT FlatSB_SetScrollInfo(
    HWND param0,
    SCROLLBAR_CONSTANTS code,
    SCROLLINFO* psi,
    BOOL fRedraw
);

パラメーター

名前

型

方向

説明

param0

HWND

対象ウィンドウのハンドル。

code

SCROLLBAR_CONSTANTS

スクロールバーの種類です。次のいずれかの値を指定できます。

値	意味
SB_HORZ	水平スクロールバーの情報を設定します。
SB_VERT	垂直スクロールバーの情報を設定します。

psi

SCROLLINFO*

inout

指定したスクロールバーの新しい情報を格納する SCROLLINFO 構造体へのポインターです。構造体の cbSize メンバーと fMask メンバーは、FlatSB_SetScrollInfo を呼び出す前に設定しておく必要があります。fMask メンバーは、構造体のどのメンバーが有効な情報を含むかを指定し、次の値の任意の組み合わせを指定できます。

値	意味
SIF_DISABLENOSCROLL	新しい情報によってスクロールバーが削除される状態になる場合、スクロールバーを無効化します。
SIF_PAGE	フラットスクロールバーのページ情報を設定します。SCROLLINFO 構造体の nPage メンバーに新しいページ値を格納しておく必要があります。
SIF_POS	フラットスクロールバーの位置情報を設定します。SCROLLINFO 構造体の nPos メンバーに新しい位置値を格納しておく必要があります。
SIF_RANGE	フラットスクロールバーの範囲情報を設定します。SCROLLINFO 構造体の nMin および nMax メンバーに新しい範囲値を格納しておく必要があります。
SIF_ALL	SIF_PAGE、SIF_POS、SIF_RANGE の組み合わせです。

fRedraw

BOOL

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

戻り値の型: INT

公式ドキュメント

フラットスクロールバーの情報を設定します。ウィンドウに対してフラットスクロールバーが初期化されていない場合、この関数は標準の SetScrollInfo 関数を呼び出します。

戻り値

Type: int

現在のスクロール位置を返します。FlatSB_SetScrollInfo の呼び出しによってスクロール位置が変更された場合は、変更前の位置が返されます。

解説(Remarks)

注意フラットスクロールバー関数は、Comctl32.dll のバージョン 4.71 から 5.82 で実装されています。Comctl32.dll のバージョン 6.00 以降はフラットスクロールバーをサポートしません。

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

各言語での呼び出し定義

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

INT FlatSB_SetScrollInfo(
    HWND param0,
    SCROLLBAR_CONSTANTS code,
    SCROLLINFO* psi,
    BOOL fRedraw
);

[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int FlatSB_SetScrollInfo(
    IntPtr param0,   // HWND
    int code,   // SCROLLBAR_CONSTANTS
    IntPtr psi,   // SCROLLINFO* in/out
    bool fRedraw   // BOOL
);

<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function FlatSB_SetScrollInfo(
    param0 As IntPtr,   ' HWND
    code As Integer,   ' SCROLLBAR_CONSTANTS
    psi As IntPtr,   ' SCROLLINFO* in/out
    fRedraw As Boolean   ' BOOL
) As Integer
End Function

' param0 : HWND
' code : SCROLLBAR_CONSTANTS
' psi : SCROLLINFO* in/out
' fRedraw : BOOL
Declare PtrSafe Function FlatSB_SetScrollInfo Lib "comctl32" ( _
    ByVal param0 As LongPtr, _
    ByVal code As Long, _
    ByVal psi As LongPtr, _
    ByVal fRedraw As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FlatSB_SetScrollInfo = ctypes.windll.comctl32.FlatSB_SetScrollInfo
FlatSB_SetScrollInfo.restype = ctypes.c_int
FlatSB_SetScrollInfo.argtypes = [
    wintypes.HANDLE,  # param0 : HWND
    ctypes.c_int,  # code : SCROLLBAR_CONSTANTS
    ctypes.c_void_p,  # psi : SCROLLINFO* in/out
    wintypes.BOOL,  # fRedraw : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
FlatSB_SetScrollInfo = Fiddle::Function.new(
  lib['FlatSB_SetScrollInfo'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HWND
    Fiddle::TYPE_INT,  # code : SCROLLBAR_CONSTANTS
    Fiddle::TYPE_VOIDP,  # psi : SCROLLINFO* in/out
    Fiddle::TYPE_INT,  # fRedraw : BOOL
  ],
  Fiddle::TYPE_INT)

#[link(name = "comctl32")]
extern "system" {
    fn FlatSB_SetScrollInfo(
        param0: *mut core::ffi::c_void,  // HWND
        code: i32,  // SCROLLBAR_CONSTANTS
        psi: *mut SCROLLINFO,  // SCROLLINFO* in/out
        fRedraw: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("COMCTL32.dll")]
public static extern int FlatSB_SetScrollInfo(IntPtr param0, int code, IntPtr psi, bool fRedraw);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_FlatSB_SetScrollInfo' -Namespace Win32 -PassThru
# $api::FlatSB_SetScrollInfo(param0, code, psi, fRedraw)

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

出力引数:

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