GetSysColorBrush

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
user32.lib
Header File
winuser.h
Unicode
No
Platform Notes
Win32s: supports only Windows 3.1 system colors.

The GetSysColorBrush function retrieves a handle identifying a logical brush that corresponds to the specified color index.

HBRUSH GetSysColorBrush(

int nIndex	// system color index
);

Parameters
nIndex

Specifies a color index. This value corresponds to the color used to paint one of the 21 window elements.

Return Values
If the function succeeds, the return value identifies a logical brush. To get extended error information, call GetLastError.

Remarks
A brush is a bitmap that Windows uses to paint the interiors of filled shapes. An application can retrieve the current system colors by calling the GetSysColor function. An application can set the current system colors by calling the SetSysColors function.

An application must not register a window class for a window using a system brush.