Gdi::GetSysColorBrush_I

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

static WINGDIAPI HBRUSH WINAPI GetSysColorBrush_I(
  int nIndex
);

Parameters

  • nIndex
    [in] Integer that specifies a color index. This value corresponds to the color used to paint one of the 21 window elements.

Return Values

Handle to a logical brush indicates success. NULL indicates failure. To get extended error information, call GetLastError.

Remarks

This method is an internal version of the GetSysColorBrush function.

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 CE are different from the values assigned to these flags in Windows-based desktop platforms. Therefore, you should specify the COLOR_* flag value, rather than the corresponding integer value, for the nIndex parameter. For a list of all the standard system colors, see GetSysColor.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Gdi.hpp.

See Also

GetSysColor | GetSysColorBrush | SetSysColors

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.