GetSysColor
関数シグネチャ
// USER32.dll
#include <windows.h>
DWORD GetSysColor(
SYS_COLOR_INDEX nIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| nIndex | SYS_COLOR_INDEX | in | 色を取得する表示要素。このパラメーターには、次のいずれかの値を指定できます。
|
戻り値の型: DWORD
公式ドキュメント
指定された表示要素の現在の色を取得します。
戻り値
型: DWORD
この関数は、指定された要素の赤、緑、青 (RGB) のカラー値を返します。
nIndex パラメーターが範囲外の場合、戻り値は 0 です。0 も有効な RGB 値であるため、GetSysColor を使用してシステム カラーが現在のプラットフォームでサポートされているかどうかを判定することはできません。代わりに GetSysColorBrush 関数を使用してください。この関数は、色がサポートされていない場合に NULL を返します。
解説(Remarks)
RGB 値の各成分を表示するには、GetRValue、GetGValue、GetBValue の各マクロを使用します。
モノクロ ディスプレイのシステム カラーは、通常、グレーの濃淡として解釈されます。
システム カラー ブラシで描画する場合、アプリケーションは CreateSolidBrush(GetSysColor(nIndex)) ではなく GetSysColorBrush(nIndex) を使用してください。GetSysColorBrush は新しいブラシを割り当てる代わりにキャッシュされたブラシを返すためです。
色は、ほとんどのユーザー インターフェイスにおいて重要な視覚的要素です。アプリケーションでの色の使用に関するガイドラインについては、Color - Win32 および Color in Windows 11 を参照してください。
Windows 10/11 のシステム カラー
この表は、Windows 10 および Windows 11 でサポートされている値を、Windows 11 の Aquatic コントラスト テーマのカラー値とともに示しています。
| カラー スウォッチ | 説明 |
|---|---|
| :::image type="icon" source="images/sys-color/aquatic-color-window.png"::: | COLOR_WINDOWページ、ペイン、ポップアップ、ウィンドウの背景。 COLOR_WINDOWTEXT と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-windowtext.png"::: | COLOR_WINDOWTEXT見出し、本文、リスト、プレースホルダー テキスト、アプリおよびウィンドウの境界線、操作できないすべての UI。COLOR_WINDOW と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-hotlight.png"::: | COLOR_HOTLIGHTハイパーリンク。COLOR_WINDOW と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-graytext.png"::: | COLOR_GRAYTEXT非アクティブ (無効) な UI。COLOR_WINDOW と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-highlighttext.png"::: | COLOR_HIGHLIGHTTEXT選択中、操作中 (ホバー、押下)、または処理中のテキストまたは UI の前景色。COLOR_HIGHLIGHT と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-highlight.png"::: | COLOR_HIGHLIGHT選択中、操作中 (ホバー、押下)、または処理中の UI の背景色またはアクセント色。COLOR_HIGHLIGHTTEXT と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-btntext.png"::: | COLOR_BTNTEXTボタンおよび操作可能なすべての UI の前景色。COLOR_3DFACE と組み合わせて使用 |
| :::image type="icon" source="images/sys-color/aquatic-color-3dface.png"::: | COLOR_3DFACEボタンおよび操作可能なすべての UI の背景色。COLOR_BTNTEXT と組み合わせて使用 |
これらの画像は、背景を COLOR_WINDOW に設定した場合に色がどのように表示されるかを示しています。
| 例 | 値 |
|---|---|
| :::image type="content" source="images/sys-color/aquatic-example-windowtext.png" alt-text="A window with text using the window text color." border="false"::: | COLOR_WINDOWTEXT |
| :::image type="content" source="images/sys-color/aquatic-example-hotlight.png" alt-text="A window with hyperlink text using the hot light color." border="false"::: | COLOR_HOTLIGHT |
| :::image type="content" source="images/sys-color/aquatic-example-graytext.png" alt-text="A window with inactive text using the gray text color." border="false"::: | COLOR_GRAYTEXT |
| :::image type="content" source="images/sys-color/aquatic-example-highlighttext+highlight.png" alt-text="A window with text using the highlight text color on the highlight color." border="false"::: | COLOR_HIGHLIGHTTEXT + HIGHLIGHT |
| :::image type="content" source="images/sys-color/aquatic-example-btntext+3dface.png" alt-text="A window with a button using the 3d face color and button text using the button text color." border="false"::: | COLOR_BTNTEXT + COLOR_3DFACE |
例
例については、 SetSysColors を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
DWORD GetSysColor(
SYS_COLOR_INDEX nIndex
);[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint GetSysColor(
int nIndex // SYS_COLOR_INDEX
);<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetSysColor(
nIndex As Integer ' SYS_COLOR_INDEX
) As UInteger
End Function' nIndex : SYS_COLOR_INDEX
Declare PtrSafe Function GetSysColor Lib "user32" ( _
ByVal nIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GetSysColor = ctypes.windll.user32.GetSysColor
GetSysColor.restype = wintypes.DWORD
GetSysColor.argtypes = [
ctypes.c_int, # nIndex : SYS_COLOR_INDEX
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
GetSysColor = Fiddle::Function.new(
lib['GetSysColor'],
[
Fiddle::TYPE_INT, # nIndex : SYS_COLOR_INDEX
],
-Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn GetSysColor(
nIndex: i32 // SYS_COLOR_INDEX
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll")]
public static extern uint GetSysColor(int nIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetSysColor' -Namespace Win32 -PassThru
# $api::GetSysColor(nIndex)#uselib "USER32.dll"
#func global GetSysColor "GetSysColor" sptr
; GetSysColor nIndex ; 戻り値は stat
; nIndex : SYS_COLOR_INDEX -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global GetSysColor "GetSysColor" int
; res = GetSysColor(nIndex)
; nIndex : SYS_COLOR_INDEX -> "int"; DWORD GetSysColor(SYS_COLOR_INDEX nIndex)
#uselib "USER32.dll"
#cfunc global GetSysColor "GetSysColor" int
; res = GetSysColor(nIndex)
; nIndex : SYS_COLOR_INDEX -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procGetSysColor = user32.NewProc("GetSysColor")
)
// nIndex (SYS_COLOR_INDEX)
r1, _, err := procGetSysColor.Call(
uintptr(nIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetSysColor(
nIndex: Integer // SYS_COLOR_INDEX
): DWORD; stdcall;
external 'USER32.dll' name 'GetSysColor';result := DllCall("USER32\GetSysColor"
, "Int", nIndex ; SYS_COLOR_INDEX
, "UInt") ; return: DWORD●GetSysColor(nIndex) = DLL("USER32.dll", "dword GetSysColor(int)")
# 呼び出し: GetSysColor(nIndex)
# nIndex : SYS_COLOR_INDEX -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn GetSysColor(
nIndex: i32 // SYS_COLOR_INDEX
) callconv(std.os.windows.WINAPI) u32;proc GetSysColor(
nIndex: int32 # SYS_COLOR_INDEX
): uint32 {.importc: "GetSysColor", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
uint GetSysColor(
int nIndex // SYS_COLOR_INDEX
);ccall((:GetSysColor, "USER32.dll"), stdcall, UInt32,
(Int32,),
nIndex)
# nIndex : SYS_COLOR_INDEX -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetSysColor(
int32_t nIndex);
]]
local user32 = ffi.load("user32")
-- user32.GetSysColor(nIndex)
-- nIndex : SYS_COLOR_INDEX
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetSysColor = lib.func('__stdcall', 'GetSysColor', 'uint32_t', ['int32_t']);
// GetSysColor(nIndex)
// nIndex : SYS_COLOR_INDEX -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
GetSysColor: { parameters: ["i32"], result: "u32" },
});
// lib.symbols.GetSysColor(nIndex)
// nIndex : SYS_COLOR_INDEX -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetSysColor(
int32_t nIndex);
C, "USER32.dll");
// $ffi->GetSysColor(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);
int GetSysColor(
int nIndex // SYS_COLOR_INDEX
);
}@[Link("user32")]
lib LibUSER32
fun GetSysColor = GetSysColor(
nIndex : Int32 # SYS_COLOR_INDEX
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetSysColorNative = Uint32 Function(Int32);
typedef GetSysColorDart = int Function(int);
final GetSysColor = DynamicLibrary.open('USER32.dll')
.lookupFunction<GetSysColorNative, GetSysColorDart>('GetSysColor');
// nIndex : SYS_COLOR_INDEX -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetSysColor(
nIndex: Integer // SYS_COLOR_INDEX
): DWORD; stdcall;
external 'USER32.dll' name 'GetSysColor';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetSysColor"
c_GetSysColor :: Int32 -> IO Word32
-- nIndex : SYS_COLOR_INDEX -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getsyscolor =
foreign "GetSysColor"
(int32_t @-> returning uint32_t)
(* 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 ("GetSysColor" get-sys-color :convention :stdcall) :uint32
(n-index :int32)) ; SYS_COLOR_INDEX
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetSysColor = Win32::API::More->new('USER32',
'DWORD GetSysColor(int nIndex)');
# my $ret = $GetSysColor->Call($nIndex);
# nIndex : SYS_COLOR_INDEX -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CreateSolidBrush — 指定した色の塗りつぶし用ソリッドブラシを作成する。
- f GetSysColorBrush — 指定したシステム色に対応するブラシハンドルを取得する。
- f SetSysColors — 指定したシステム表示要素の色を変更する。
- f SystemParametersInfoW — システム全体のパラメータを取得または設定する(Unicode版)。