Win32 API 日本語リファレンス
ホームUI.Controls › FlatSB_GetScrollRange

FlatSB_GetScrollRange

関数
フラットスクロールバーのスクロール範囲を取得する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOL FlatSB_GetScrollRange(
    HWND param0,
    SCROLLBAR_CONSTANTS code,
    INT* param2,
    INT* param3
);

パラメーター

名前方向説明
param0HWNDin対象ウィンドウのハンドル。
codeSCROLLBAR_CONSTANTSin

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

意味
SB_HORZ
水平スクロールバーのスクロール範囲を取得します。
SB_VERT
垂直スクロールバーのスクロール範囲を取得します。
param2INT*inout範囲の最小値を受け取るINT変数へのポインタ(出力)。
param3INT*inout範囲の最大値を受け取るINT変数へのポインタ(出力)。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

Type: BOOL

成功した場合は 0 以外の値を返し、それ以外の場合は 0 を返します。

解説(Remarks)

Note フラットスクロールバー関数は、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>

BOOL FlatSB_GetScrollRange(
    HWND param0,
    SCROLLBAR_CONSTANTS code,
    INT* param2,
    INT* param3
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern bool FlatSB_GetScrollRange(
    IntPtr param0,   // HWND
    int code,   // SCROLLBAR_CONSTANTS
    ref int param2,   // INT* in/out
    ref int param3   // INT* in/out
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function FlatSB_GetScrollRange(
    param0 As IntPtr,   ' HWND
    code As Integer,   ' SCROLLBAR_CONSTANTS
    ByRef param2 As Integer,   ' INT* in/out
    ByRef param3 As Integer   ' INT* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HWND
' code : SCROLLBAR_CONSTANTS
' param2 : INT* in/out
' param3 : INT* in/out
Declare PtrSafe Function FlatSB_GetScrollRange Lib "comctl32" ( _
    ByVal param0 As LongPtr, _
    ByVal code As Long, _
    ByRef param2 As Long, _
    ByRef param3 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FlatSB_GetScrollRange = ctypes.windll.comctl32.FlatSB_GetScrollRange
FlatSB_GetScrollRange.restype = wintypes.BOOL
FlatSB_GetScrollRange.argtypes = [
    wintypes.HANDLE,  # param0 : HWND
    ctypes.c_int,  # code : SCROLLBAR_CONSTANTS
    ctypes.POINTER(ctypes.c_int),  # param2 : INT* in/out
    ctypes.POINTER(ctypes.c_int),  # param3 : INT* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
FlatSB_GetScrollRange = Fiddle::Function.new(
  lib['FlatSB_GetScrollRange'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HWND
    Fiddle::TYPE_INT,  # code : SCROLLBAR_CONSTANTS
    Fiddle::TYPE_VOIDP,  # param2 : INT* in/out
    Fiddle::TYPE_VOIDP,  # param3 : INT* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn FlatSB_GetScrollRange(
        param0: *mut core::ffi::c_void,  // HWND
        code: i32,  // SCROLLBAR_CONSTANTS
        param2: *mut i32,  // INT* in/out
        param3: *mut i32  // INT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll")]
public static extern bool FlatSB_GetScrollRange(IntPtr param0, int code, ref int param2, ref int param3);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_FlatSB_GetScrollRange' -Namespace Win32 -PassThru
# $api::FlatSB_GetScrollRange(param0, code, param2, param3)
#uselib "COMCTL32.dll"
#func global FlatSB_GetScrollRange "FlatSB_GetScrollRange" sptr, sptr, sptr, sptr
; FlatSB_GetScrollRange param0, code, varptr(param2), varptr(param3)   ; 戻り値は stat
; param0 : HWND -> "sptr"
; code : SCROLLBAR_CONSTANTS -> "sptr"
; param2 : INT* in/out -> "sptr"
; param3 : INT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "COMCTL32.dll"
#cfunc global FlatSB_GetScrollRange "FlatSB_GetScrollRange" sptr, int, var, var
; res = FlatSB_GetScrollRange(param0, code, param2, param3)
; param0 : HWND -> "sptr"
; code : SCROLLBAR_CONSTANTS -> "int"
; param2 : INT* in/out -> "var"
; param3 : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FlatSB_GetScrollRange(HWND param0, SCROLLBAR_CONSTANTS code, INT* param2, INT* param3)
#uselib "COMCTL32.dll"
#cfunc global FlatSB_GetScrollRange "FlatSB_GetScrollRange" intptr, int, var, var
; res = FlatSB_GetScrollRange(param0, code, param2, param3)
; param0 : HWND -> "intptr"
; code : SCROLLBAR_CONSTANTS -> "int"
; param2 : INT* in/out -> "var"
; param3 : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procFlatSB_GetScrollRange = comctl32.NewProc("FlatSB_GetScrollRange")
)

// param0 (HWND), code (SCROLLBAR_CONSTANTS), param2 (INT* in/out), param3 (INT* in/out)
r1, _, err := procFlatSB_GetScrollRange.Call(
	uintptr(param0),
	uintptr(code),
	uintptr(param2),
	uintptr(param3),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FlatSB_GetScrollRange(
  param0: THandle;   // HWND
  code: Integer;   // SCROLLBAR_CONSTANTS
  param2: Pointer;   // INT* in/out
  param3: Pointer   // INT* in/out
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'FlatSB_GetScrollRange';
result := DllCall("COMCTL32\FlatSB_GetScrollRange"
    , "Ptr", param0   ; HWND
    , "Int", code   ; SCROLLBAR_CONSTANTS
    , "Ptr", param2   ; INT* in/out
    , "Ptr", param3   ; INT* in/out
    , "Int")   ; return: BOOL
●FlatSB_GetScrollRange(param0, code, param2, param3) = DLL("COMCTL32.dll", "bool FlatSB_GetScrollRange(void*, int, void*, void*)")
# 呼び出し: FlatSB_GetScrollRange(param0, code, param2, param3)
# param0 : HWND -> "void*"
# code : SCROLLBAR_CONSTANTS -> "int"
# param2 : INT* in/out -> "void*"
# param3 : INT* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "comctl32" fn FlatSB_GetScrollRange(
    param0: ?*anyopaque, // HWND
    code: i32, // SCROLLBAR_CONSTANTS
    param2: [*c]i32, // INT* in/out
    param3: [*c]i32 // INT* in/out
) callconv(std.os.windows.WINAPI) i32;
proc FlatSB_GetScrollRange(
    param0: pointer,  # HWND
    code: int32,  # SCROLLBAR_CONSTANTS
    param2: ptr int32,  # INT* in/out
    param3: ptr int32  # INT* in/out
): int32 {.importc: "FlatSB_GetScrollRange", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int FlatSB_GetScrollRange(
    void* param0,   // HWND
    int code,   // SCROLLBAR_CONSTANTS
    int* param2,   // INT* in/out
    int* param3   // INT* in/out
);
ccall((:FlatSB_GetScrollRange, "COMCTL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Int32}, Ptr{Int32}),
      param0, code, param2, param3)
# param0 : HWND -> Ptr{Cvoid}
# code : SCROLLBAR_CONSTANTS -> Int32
# param2 : INT* in/out -> Ptr{Int32}
# param3 : INT* in/out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FlatSB_GetScrollRange(
    void* param0,
    int32_t code,
    int32_t* param2,
    int32_t* param3);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.FlatSB_GetScrollRange(param0, code, param2, param3)
-- param0 : HWND
-- code : SCROLLBAR_CONSTANTS
-- param2 : INT* in/out
-- param3 : INT* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const FlatSB_GetScrollRange = lib.func('__stdcall', 'FlatSB_GetScrollRange', 'int32_t', ['void *', 'int32_t', 'int32_t *', 'int32_t *']);
// FlatSB_GetScrollRange(param0, code, param2, param3)
// param0 : HWND -> 'void *'
// code : SCROLLBAR_CONSTANTS -> 'int32_t'
// param2 : INT* in/out -> 'int32_t *'
// param3 : INT* in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("COMCTL32.dll", {
  FlatSB_GetScrollRange: { parameters: ["pointer", "i32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FlatSB_GetScrollRange(param0, code, param2, param3)
// param0 : HWND -> "pointer"
// code : SCROLLBAR_CONSTANTS -> "i32"
// param2 : INT* in/out -> "pointer"
// param3 : INT* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FlatSB_GetScrollRange(
    void* param0,
    int32_t code,
    int32_t* param2,
    int32_t* param3);
C, "COMCTL32.dll");
// $ffi->FlatSB_GetScrollRange(param0, code, param2, param3);
// param0 : HWND
// code : SCROLLBAR_CONSTANTS
// param2 : INT* in/out
// param3 : INT* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Comctl32 extends StdCallLibrary {
    Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class);
    boolean FlatSB_GetScrollRange(
        Pointer param0,   // HWND
        int code,   // SCROLLBAR_CONSTANTS
        IntByReference param2,   // INT* in/out
        IntByReference param3   // INT* in/out
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun FlatSB_GetScrollRange = FlatSB_GetScrollRange(
    param0 : Void*,   # HWND
    code : Int32,   # SCROLLBAR_CONSTANTS
    param2 : Int32*,   # INT* in/out
    param3 : Int32*   # INT* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FlatSB_GetScrollRangeNative = Int32 Function(Pointer<Void>, Int32, Pointer<Int32>, Pointer<Int32>);
typedef FlatSB_GetScrollRangeDart = int Function(Pointer<Void>, int, Pointer<Int32>, Pointer<Int32>);
final FlatSB_GetScrollRange = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<FlatSB_GetScrollRangeNative, FlatSB_GetScrollRangeDart>('FlatSB_GetScrollRange');
// param0 : HWND -> Pointer<Void>
// code : SCROLLBAR_CONSTANTS -> Int32
// param2 : INT* in/out -> Pointer<Int32>
// param3 : INT* in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FlatSB_GetScrollRange(
  param0: THandle;   // HWND
  code: Integer;   // SCROLLBAR_CONSTANTS
  param2: Pointer;   // INT* in/out
  param3: Pointer   // INT* in/out
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'FlatSB_GetScrollRange';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FlatSB_GetScrollRange"
  c_FlatSB_GetScrollRange :: Ptr () -> Int32 -> Ptr Int32 -> Ptr Int32 -> IO CInt
-- param0 : HWND -> Ptr ()
-- code : SCROLLBAR_CONSTANTS -> Int32
-- param2 : INT* in/out -> Ptr Int32
-- param3 : INT* in/out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let flatsb_getscrollrange =
  foreign "FlatSB_GetScrollRange"
    ((ptr void) @-> int32_t @-> (ptr int32_t) @-> (ptr int32_t) @-> returning int32_t)
(* param0 : HWND -> (ptr void) *)
(* code : SCROLLBAR_CONSTANTS -> int32_t *)
(* param2 : INT* in/out -> (ptr int32_t) *)
(* param3 : INT* in/out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("FlatSB_GetScrollRange" flat-sb-get-scroll-range :convention :stdcall) :int32
  (param0 :pointer)   ; HWND
  (code :int32)   ; SCROLLBAR_CONSTANTS
  (param2 :pointer)   ; INT* in/out
  (param3 :pointer))   ; INT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FlatSB_GetScrollRange = Win32::API::More->new('COMCTL32',
    'BOOL FlatSB_GetScrollRange(HANDLE param0, int code, LPVOID param2, LPVOID param3)');
# my $ret = $FlatSB_GetScrollRange->Call($param0, $code, $param2, $param3);
# param0 : HWND -> HANDLE
# code : SCROLLBAR_CONSTANTS -> int
# param2 : INT* in/out -> LPVOID
# param3 : INT* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型