SetSysColors

関数

指定したシステム表示要素の色を変更する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetSysColors(
    INT cElements,
    const INT* lpaElements,
    const COLORREF* lpaRgbValues
);

パラメーター

名前	型	方向	説明
cElements	INT	in	lpaElements 配列内の表示要素の数。
lpaElements	INT*	in	変更する表示要素を指定する整数の配列。表示要素の一覧については、 GetSysColor を参照してください。
lpaRgbValues	COLORREF*	in	lpaElements パラメーターが指す配列内の表示要素に対する、新しい赤、緑、青 (RGB) の色値を含む COLORREF 値の配列。 COLORREF を生成するには、 RGB マクロを使用します。

名前

型

方向

説明

cElements

INT

lpaElements 配列内の表示要素の数。

lpaElements

INT*

変更する表示要素を指定する整数の配列。表示要素の一覧については、 GetSysColor を参照してください。

lpaRgbValues

COLORREF*

lpaElements パラメーターが指す配列内の表示要素に対する、新しい赤、緑、青 (RGB) の色値を含む COLORREF 値の配列。

COLORREF を生成するには、 RGB マクロを使用します。

戻り値の型: BOOL

公式ドキュメント

指定された表示要素の色を設定します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

SetSysColors 関数は、色の変更を通知するためにすべてのウィンドウへ WM_SYSCOLORCHANGE メッセージを送信します。また、現在表示されているすべてのウィンドウの影響を受ける部分を再描画するようシステムに指示します。

ユーザーが指定した色設定を尊重することが最善です。ユーザーが色を変更できるようにするアプリケーションを作成する場合は、この関数を使用するのが適切です。ただし、この関数は現在のセッションにのみ影響します。システムが終了すると、新しい色は保存されません。

例

次の例は、GetSysColor 関数と SetSysColors 関数の使用方法を示しています。まず、この例では GetSysColor を使用してウィンドウの背景とアクティブなキャプションの色を取得し、赤、緑、青 (RGB) の値を 16 進表記で表示します。次に、SetSysColors を使用してウィンドウの背景の色を明るい灰色に、アクティブなタイトルバーを濃い紫に変更します。10 秒間の遅延の後、この例では SetSysColors を使用してこれらの要素を以前の色に復元します。

#include <windows.h>
#include <stdio.h>
#pragma comment(lib, "user32.lib")

void main()
{
    int aElements[2] = {COLOR_WINDOW, COLOR_ACTIVECAPTION};
    DWORD aOldColors[2];
    DWORD aNewColors[2];

    // Get the current color of the window background. 
 
    aOldColors[0] = GetSysColor(aElements[0]); 

    printf("Current window color: {0x%x, 0x%x, 0x%x}\n", 
        GetRValue(aOldColors[0]), 
        GetGValue(aOldColors[0]), 
        GetBValue(aOldColors[0]));

    // Get the current color of the active caption. 
 
    aOldColors[1] = GetSysColor(aElements[1]); 

    printf("Current active caption color: {0x%x, 0x%x, 0x%x}\n", 
        GetRValue(aOldColors[1]), 
        GetGValue(aOldColors[1]), 
        GetBValue(aOldColors[1]));

    // Define new colors for the elements

    aNewColors[0] = RGB(0x80, 0x80, 0x80);  // light gray 
    aNewColors[1] = RGB(0x80, 0x00, 0x80);  // dark purple 

    printf("\nNew window color: {0x%x, 0x%x, 0x%x}\n", 
        GetRValue(aNewColors[0]), 
        GetGValue(aNewColors[0]), 
        GetBValue(aNewColors[0]));

    printf("New active caption color: {0x%x, 0x%x, 0x%x}\n", 
        GetRValue(aNewColors[1]), 
        GetGValue(aNewColors[1]), 
        GetBValue(aNewColors[1]));

    // Set the elements defined in aElements to the colors defined
    // in aNewColors

    SetSysColors(2, aElements, aNewColors); 

    printf("\nWindow background and active border have been changed.\n");
    printf("Reverting to previous colors in 10 seconds...\n");

    Sleep(10000);    

    // Restore the elements to their original colors

    SetSysColors(2, aElements, aOldColors); 
}

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

各言語での呼び出し定義

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

BOOL SetSysColors(
    INT cElements,
    const INT* lpaElements,
    const COLORREF* lpaRgbValues
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetSysColors(
    int cElements,   // INT
    ref int lpaElements,   // INT*
    ref uint lpaRgbValues   // COLORREF*
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetSysColors(
    cElements As Integer,   ' INT
    ByRef lpaElements As Integer,   ' INT*
    ByRef lpaRgbValues As UInteger   ' COLORREF*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' cElements : INT
' lpaElements : INT*
' lpaRgbValues : COLORREF*
Declare PtrSafe Function SetSysColors Lib "user32" ( _
    ByVal cElements As Long, _
    ByRef lpaElements As Long, _
    ByRef lpaRgbValues As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetSysColors = ctypes.windll.user32.SetSysColors
SetSysColors.restype = wintypes.BOOL
SetSysColors.argtypes = [
    ctypes.c_int,  # cElements : INT
    ctypes.POINTER(ctypes.c_int),  # lpaElements : INT*
    ctypes.c_void_p,  # lpaRgbValues : COLORREF*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetSysColors = Fiddle::Function.new(
  lib['SetSysColors'],
  [
    Fiddle::TYPE_INT,  # cElements : INT
    Fiddle::TYPE_VOIDP,  # lpaElements : INT*
    Fiddle::TYPE_VOIDP,  # lpaRgbValues : COLORREF*
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn SetSysColors(
        cElements: i32,  // INT
        lpaElements: *const i32,  // INT*
        lpaRgbValues: *const u32  // COLORREF*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool SetSysColors(int cElements, ref int lpaElements, ref uint lpaRgbValues);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetSysColors' -Namespace Win32 -PassThru
# $api::SetSysColors(cElements, lpaElements, lpaRgbValues)

#uselib "USER32.dll"
#func global SetSysColors "SetSysColors" sptr, sptr, sptr
; SetSysColors cElements, varptr(lpaElements), varptr(lpaRgbValues)   ; 戻り値は stat
; cElements : INT -> "sptr"
; lpaElements : INT* -> "sptr"
; lpaRgbValues : COLORREF* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global SetSysColors "SetSysColors" int, var, var
; res = SetSysColors(cElements, lpaElements, lpaRgbValues)
; cElements : INT -> "int"
; lpaElements : INT* -> "var"
; lpaRgbValues : COLORREF* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global SetSysColors "SetSysColors" int, sptr, sptr
; res = SetSysColors(cElements, varptr(lpaElements), varptr(lpaRgbValues))
; cElements : INT -> "int"
; lpaElements : INT* -> "sptr"
; lpaRgbValues : COLORREF* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。