GetSysColorBrush 関数 (winuser.h)

[アーティクル]
03/13/2024

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

構文

HBRUSH GetSysColorBrush(
  [in] int nIndex
);

パラメーター

[in] nIndex

色のインデックス。この値は、ウィンドウ要素の 1 つを描画するために使用される色に対応します。システムの色のインデックス値については、「 GetSysColor 」を参照してください。

戻り値

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

注釈

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

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

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

システムカラーブラシを使用して描画するには、アプリケーションで CreateSolidBrush ( GetSysColor (nIndex)) ではなく GetSysColorBrush (nIndex) を使用する必要があります。これは、GetSysColorBrush は新しいブラシを割り当てる代わりにキャッシュされたブラシを返すからです。

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

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll
API セット	ext-ms-win-ntuser-gui-l1-1-1 (Windows 8.1 で導入)