GetSysColorBrush

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

HBRUSH GetSysColorBrush(
  int nIndex
); 

Parameters

  • nIndex
    [in] Specifies a color index.

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

Return Value

Handle to a logical brush indicates success.

NULL indicates failure.

To get extended error information, call GetLastError.

Remarks

A brush is a bitmap that the system 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.

The values assigned to the COLOR_* flags in Windows Embedded CE are different from the values assigned to these flags in Windows-based desktop platforms. Therefore, specify the COLOR_* flag value, rather than the corresponding integer value, for the nIndex parameter.

For a list of all standard system colors, see GetSysColor.

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

GetSysColor
SetSysColors
GDI Functions