Win32 API 日本語リファレンス
ホームGraphics.Gdi › GetSysColorBrush

GetSysColorBrush

関数
指定したシステム色に対応するブラシハンドルを取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HBRUSH GetSysColorBrush(
    SYS_COLOR_INDEX nIndex
);

パラメーター

名前方向説明
nIndexSYS_COLOR_INDEXin色インデックス。この値は、ウィンドウ要素のいずれかを描画するために使用される色に対応します。システムの色インデックス値については、GetSysColor を参照してください。

戻り値の型: HBRUSH

公式ドキュメント

GetSysColorBrush 関数は、指定された色インデックスに対応する論理ブラシを識別するハンドルを取得します。

戻り値

nIndex パラメーターが現在のプラットフォームでサポートされている場合、戻り値は論理ブラシを識別します。それ以外の場合は NULL を返します。

解説(Remarks)

ブラシは、塗りつぶされた図形の内部を描画するためにシステムが使用するビットマップです。アプリケーションは、GetSysColor 関数を呼び出すことで、現在のシステム色を取得できます。また、SetSysColors 関数を呼び出すことで、現在のシステム色を設定できます。

アプリケーションは、システムブラシを使用するウィンドウに対してウィンドウクラスを登録してはなりません。システム色を使用してウィンドウクラスを登録するには、WNDCLASS 構造体または WNDCLASSEX 構造体の hbrBackground メンバーのドキュメントを参照してください。

システム色ブラシは、システム色の変更を追跡します。つまり、ユーザーがシステム色を変更すると、関連付けられたシステム色ブラシは自動的に新しい色に変更されます。

システム色ブラシで描画するには、アプリケーションは CreateSolidBrush ( GetSysColor (nIndex)) ではなく、GetSysColorBrush (nIndex) を使用すべきです。GetSysColorBrush は新しいブラシを割り当てる代わりにキャッシュされたブラシを返すためです。

システム色ブラシはシステムによって所有されているため、破棄する必要はありません。GetSysColorBrush が返す論理ブラシを削除する必要はありませんが、DeleteObject を呼び出しても問題は発生しません。

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

各言語での呼び出し定義

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

HBRUSH GetSysColorBrush(
    SYS_COLOR_INDEX nIndex
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr GetSysColorBrush(
    int nIndex   // SYS_COLOR_INDEX
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetSysColorBrush(
    nIndex As Integer   ' SYS_COLOR_INDEX
) As IntPtr
End Function
' nIndex : SYS_COLOR_INDEX
Declare PtrSafe Function GetSysColorBrush Lib "user32" ( _
    ByVal nIndex As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetSysColorBrush = ctypes.windll.user32.GetSysColorBrush
GetSysColorBrush.restype = ctypes.c_void_p
GetSysColorBrush.argtypes = [
    ctypes.c_int,  # nIndex : SYS_COLOR_INDEX
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetSysColorBrush = Fiddle::Function.new(
  lib['GetSysColorBrush'],
  [
    Fiddle::TYPE_INT,  # nIndex : SYS_COLOR_INDEX
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn GetSysColorBrush(
        nIndex: i32  // SYS_COLOR_INDEX
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern IntPtr GetSysColorBrush(int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetSysColorBrush' -Namespace Win32 -PassThru
# $api::GetSysColorBrush(nIndex)
#uselib "USER32.dll"
#func global GetSysColorBrush "GetSysColorBrush" sptr
; GetSysColorBrush nIndex   ; 戻り値は stat
; nIndex : SYS_COLOR_INDEX -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetSysColorBrush "GetSysColorBrush" int
; res = GetSysColorBrush(nIndex)
; nIndex : SYS_COLOR_INDEX -> "int"
; HBRUSH GetSysColorBrush(SYS_COLOR_INDEX nIndex)
#uselib "USER32.dll"
#cfunc global GetSysColorBrush "GetSysColorBrush" int
; res = GetSysColorBrush(nIndex)
; nIndex : SYS_COLOR_INDEX -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetSysColorBrush = user32.NewProc("GetSysColorBrush")
)

// nIndex (SYS_COLOR_INDEX)
r1, _, err := procGetSysColorBrush.Call(
	uintptr(nIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HBRUSH
function GetSysColorBrush(
  nIndex: Integer   // SYS_COLOR_INDEX
): THandle; stdcall;
  external 'USER32.dll' name 'GetSysColorBrush';
result := DllCall("USER32\GetSysColorBrush"
    , "Int", nIndex   ; SYS_COLOR_INDEX
    , "Ptr")   ; return: HBRUSH
●GetSysColorBrush(nIndex) = DLL("USER32.dll", "void* GetSysColorBrush(int)")
# 呼び出し: GetSysColorBrush(nIndex)
# nIndex : SYS_COLOR_INDEX -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetSysColorBrush(
    nIndex: i32 // SYS_COLOR_INDEX
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc GetSysColorBrush(
    nIndex: int32  # SYS_COLOR_INDEX
): pointer {.importc: "GetSysColorBrush", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* GetSysColorBrush(
    int nIndex   // SYS_COLOR_INDEX
);
ccall((:GetSysColorBrush, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Int32,),
      nIndex)
# nIndex : SYS_COLOR_INDEX -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* GetSysColorBrush(
    int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetSysColorBrush(nIndex)
-- nIndex : SYS_COLOR_INDEX
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetSysColorBrush = lib.func('__stdcall', 'GetSysColorBrush', 'void *', ['int32_t']);
// GetSysColorBrush(nIndex)
// nIndex : SYS_COLOR_INDEX -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetSysColorBrush: { parameters: ["i32"], result: "pointer" },
});
// lib.symbols.GetSysColorBrush(nIndex)
// nIndex : SYS_COLOR_INDEX -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* GetSysColorBrush(
    int32_t nIndex);
C, "USER32.dll");
// $ffi->GetSysColorBrush(nIndex);
// nIndex : SYS_COLOR_INDEX
// 構造体/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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    Pointer GetSysColorBrush(
        int nIndex   // SYS_COLOR_INDEX
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetSysColorBrush = GetSysColorBrush(
    nIndex : Int32   # SYS_COLOR_INDEX
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetSysColorBrushNative = Pointer<Void> Function(Int32);
typedef GetSysColorBrushDart = Pointer<Void> Function(int);
final GetSysColorBrush = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetSysColorBrushNative, GetSysColorBrushDart>('GetSysColorBrush');
// nIndex : SYS_COLOR_INDEX -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetSysColorBrush(
  nIndex: Integer   // SYS_COLOR_INDEX
): THandle; stdcall;
  external 'USER32.dll' name 'GetSysColorBrush';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetSysColorBrush"
  c_GetSysColorBrush :: Int32 -> IO (Ptr ())
-- nIndex : SYS_COLOR_INDEX -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getsyscolorbrush =
  foreign "GetSysColorBrush"
    (int32_t @-> returning (ptr void))
(* nIndex : SYS_COLOR_INDEX -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetSysColorBrush" get-sys-color-brush :convention :stdcall) :pointer
  (n-index :int32))   ; SYS_COLOR_INDEX
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetSysColorBrush = Win32::API::More->new('USER32',
    'HANDLE GetSysColorBrush(int nIndex)');
# my $ret = $GetSysColorBrush->Call($nIndex);
# nIndex : SYS_COLOR_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型