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

FlatSB_GetScrollProp

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

シグネチャ

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

BOOL FlatSB_GetScrollProp(
    HWND param0,
    WSB_PROP propIndex,
    INT* param2
);

パラメーター

名前方向説明
param0HWNDin対象ウィンドウのハンドル。
propIndexWSB_PROPin
                <i>pValue</i> が何を表すか、およびどのプロパティを取得するかを決定するパラメーターです。次のいずれかの値を指定できます。
意味
WSB_PROP_CXHSCROLL
pValue は、水平スクロールバーの方向ボタンの幅(ピクセル単位)を受け取る INT 値へのポインターです。
WSB_PROP_CXHTHUMB
pValue は、水平スクロールバーのつまみ(thumb)の幅(ピクセル単位)を受け取る INT 値へのポインターです。
WSB_PROP_CXVSCROLL
pValue は、垂直スクロールバーの幅(ピクセル単位)を受け取る INT 値へのポインターです。
WSB_PROP_CYHSCROLL
pValue は、水平スクロールバーの高さ(ピクセル単位)を受け取る INT 値へのポインターです。
WSB_PROP_CYVSCROLL
pValue は、垂直スクロールバーの方向ボタンの高さ(ピクセル単位)を受け取る INT 値へのポインターです。
WSB_PROP_CYVTHUMB
pValue は、垂直スクロールバーのつまみ(thumb)の高さ(ピクセル単位)を受け取る INT 値へのポインターです。
WSB_PROP_HBKGCOLOR
pValue は、水平スクロールバーの背景色を受け取る COLORREF 値へのポインターです。
WSB_PROP_HSTYLE
pValue は、水平スクロールバーに対する次のいずれかの視覚効果を受け取る INT 値へのポインターです。
FSB_ENCARTA_MODE
標準的なフラットスクロールバーが表示されます。マウスが方向ボタンまたはつまみの上に移動すると、その部分が立体(3-D)で表示されます。
FSB_FLAT_MODE
標準的なフラットスクロールバーが表示されます。マウスが方向ボタンまたはつまみの上に移動すると、その部分が反転色で表示されます。
FSB_REGULAR_MODE
通常の(フラットでない)スクロールバーが表示されます。特別な視覚効果は適用されません。
WSB_PROP_PALETTE
pValue は、スクロールバーが描画時に使用するパレットを受け取る HPALETTE 値へのポインターです。
WSB_PROP_VBKGCOLOR
pValue は、垂直スクロールバーの背景色を受け取る COLORREF 値へのポインターです。
WSB_PROP_VSTYLE
pValue は、垂直スクロールバーに対する次のいずれかの視覚効果を受け取る INT 値へのポインターです。
FSB_ENCARTA_MODE
標準的なフラットスクロールバーが表示されます。マウスが方向ボタンまたはつまみの上に移動すると、その部分が立体(3-D)で表示されます。
FSB_FLAT_MODE
標準的なフラットスクロールバーが表示されます。マウスが方向ボタンまたはつまみの上に移動すると、その部分が反転色で表示されます。
FSB_REGULAR_MODE
通常の(フラットでない)スクロールバーが表示されます。特別な視覚効果は適用されません。
WSB_PROP_WINSTYLE
pValue は、現在のウィンドウが保持する WS_HSCROLL および WS_VSCROLL のスタイルビットを受け取る INT 値へのポインターです。
param2INT*inoutプロパティ値を受け取るINT変数へのポインタ(出力)。

戻り値の型: BOOL

公式ドキュメント

フラットスクロールバーのプロパティを取得します。この関数は、対象のウィンドウに対して InitializeFlatSB が呼び出されているかどうかを判定するためにも使用できます。

戻り値

型: BOOL

成功した場合は 0 以外の値を、それ以外の場合は 0 を返します。 indexWSB_PROP_HSTYLE の場合、このウィンドウに対して InitializeFlatSB が呼び出されていれば 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_GetScrollProp(
    HWND param0,
    WSB_PROP propIndex,
    INT* param2
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern bool FlatSB_GetScrollProp(
    IntPtr param0,   // HWND
    int propIndex,   // WSB_PROP
    ref int param2   // INT* in/out
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function FlatSB_GetScrollProp(
    param0 As IntPtr,   ' HWND
    propIndex As Integer,   ' WSB_PROP
    ByRef param2 As Integer   ' INT* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' param0 : HWND
' propIndex : WSB_PROP
' param2 : INT* in/out
Declare PtrSafe Function FlatSB_GetScrollProp Lib "comctl32" ( _
    ByVal param0 As LongPtr, _
    ByVal propIndex As Long, _
    ByRef param2 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('COMCTL32.dll')
FlatSB_GetScrollProp = Fiddle::Function.new(
  lib['FlatSB_GetScrollProp'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : HWND
    Fiddle::TYPE_INT,  # propIndex : WSB_PROP
    Fiddle::TYPE_VOIDP,  # param2 : INT* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn FlatSB_GetScrollProp(
        param0: *mut core::ffi::c_void,  // HWND
        propIndex: i32,  // WSB_PROP
        param2: *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_GetScrollProp(IntPtr param0, int propIndex, ref int param2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_FlatSB_GetScrollProp' -Namespace Win32 -PassThru
# $api::FlatSB_GetScrollProp(param0, propIndex, param2)
#uselib "COMCTL32.dll"
#func global FlatSB_GetScrollProp "FlatSB_GetScrollProp" sptr, sptr, sptr
; FlatSB_GetScrollProp param0, propIndex, varptr(param2)   ; 戻り値は stat
; param0 : HWND -> "sptr"
; propIndex : WSB_PROP -> "sptr"
; param2 : INT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "COMCTL32.dll"
#cfunc global FlatSB_GetScrollProp "FlatSB_GetScrollProp" sptr, int, var
; res = FlatSB_GetScrollProp(param0, propIndex, param2)
; param0 : HWND -> "sptr"
; propIndex : WSB_PROP -> "int"
; param2 : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FlatSB_GetScrollProp(HWND param0, WSB_PROP propIndex, INT* param2)
#uselib "COMCTL32.dll"
#cfunc global FlatSB_GetScrollProp "FlatSB_GetScrollProp" intptr, int, var
; res = FlatSB_GetScrollProp(param0, propIndex, param2)
; param0 : HWND -> "intptr"
; propIndex : WSB_PROP -> "int"
; param2 : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procFlatSB_GetScrollProp = comctl32.NewProc("FlatSB_GetScrollProp")
)

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

extern "comctl32" fn FlatSB_GetScrollProp(
    param0: ?*anyopaque, // HWND
    propIndex: i32, // WSB_PROP
    param2: [*c]i32 // INT* in/out
) callconv(std.os.windows.WINAPI) i32;
proc FlatSB_GetScrollProp(
    param0: pointer,  # HWND
    propIndex: int32,  # WSB_PROP
    param2: ptr int32  # INT* in/out
): int32 {.importc: "FlatSB_GetScrollProp", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int FlatSB_GetScrollProp(
    void* param0,   // HWND
    int propIndex,   // WSB_PROP
    int* param2   // INT* in/out
);
ccall((:FlatSB_GetScrollProp, "COMCTL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Int32}),
      param0, propIndex, param2)
# param0 : HWND -> Ptr{Cvoid}
# propIndex : WSB_PROP -> Int32
# param2 : INT* in/out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FlatSB_GetScrollProp(
    void* param0,
    int32_t propIndex,
    int32_t* param2);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.FlatSB_GetScrollProp(param0, propIndex, param2)
-- param0 : HWND
-- propIndex : WSB_PROP
-- param2 : INT* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const FlatSB_GetScrollProp = lib.func('__stdcall', 'FlatSB_GetScrollProp', 'int32_t', ['void *', 'int32_t', 'int32_t *']);
// FlatSB_GetScrollProp(param0, propIndex, param2)
// param0 : HWND -> 'void *'
// propIndex : WSB_PROP -> 'int32_t'
// param2 : INT* in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("COMCTL32.dll", {
  FlatSB_GetScrollProp: { parameters: ["pointer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.FlatSB_GetScrollProp(param0, propIndex, param2)
// param0 : HWND -> "pointer"
// propIndex : WSB_PROP -> "i32"
// param2 : INT* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FlatSB_GetScrollProp(
    void* param0,
    int32_t propIndex,
    int32_t* param2);
C, "COMCTL32.dll");
// $ffi->FlatSB_GetScrollProp(param0, propIndex, param2);
// param0 : HWND
// propIndex : WSB_PROP
// param2 : 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_GetScrollProp(
        Pointer param0,   // HWND
        int propIndex,   // WSB_PROP
        IntByReference param2   // INT* in/out
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun FlatSB_GetScrollProp = FlatSB_GetScrollProp(
    param0 : Void*,   # HWND
    propIndex : Int32,   # WSB_PROP
    param2 : 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_GetScrollPropNative = Int32 Function(Pointer<Void>, Int32, Pointer<Int32>);
typedef FlatSB_GetScrollPropDart = int Function(Pointer<Void>, int, Pointer<Int32>);
final FlatSB_GetScrollProp = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<FlatSB_GetScrollPropNative, FlatSB_GetScrollPropDart>('FlatSB_GetScrollProp');
// param0 : HWND -> Pointer<Void>
// propIndex : WSB_PROP -> Int32
// param2 : INT* in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FlatSB_GetScrollProp(
  param0: THandle;   // HWND
  propIndex: Integer;   // WSB_PROP
  param2: Pointer   // INT* in/out
): BOOL; stdcall;
  external 'COMCTL32.dll' name 'FlatSB_GetScrollProp';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let flatsb_getscrollprop =
  foreign "FlatSB_GetScrollProp"
    ((ptr void) @-> int32_t @-> (ptr int32_t) @-> returning int32_t)
(* param0 : HWND -> (ptr void) *)
(* propIndex : WSB_PROP -> int32_t *)
(* param2 : 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_GetScrollProp" flat-sb-get-scroll-prop :convention :stdcall) :int32
  (param0 :pointer)   ; HWND
  (prop-index :int32)   ; WSB_PROP
  (param2 :pointer))   ; INT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FlatSB_GetScrollProp = Win32::API::More->new('COMCTL32',
    'BOOL FlatSB_GetScrollProp(HANDLE param0, int propIndex, LPVOID param2)');
# my $ret = $FlatSB_GetScrollProp->Call($param0, $propIndex, $param2);
# param0 : HWND -> HANDLE
# propIndex : WSB_PROP -> int
# param2 : INT* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型