SetSysColors

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
user32.lib
Header File
winuser.h
Unicode
No
Platform Notes
None

The SetSysColors function sets the colors for one or more display elements. Display elements are the various parts of a window and the Windows display that appear on the system display screen.

BOOL WINAPI SetSysColors(

int cElements,	// number of elements to change
CONST INT *lpaElements,	// address of array of elements
CONST COLORREF *lpaRgbValues	// address of array of RGB values
);

Parameters
cElements

Specifies the number of display elements in the array pointed to by the lpaElements parameter.

lpaElements

Points to an array of integers that specify the display elements to be changed. For a list of display elements, see the GetSysColor function.

lpaRgbValues

Points to an array of unsigned long integers that contains the new red, green, blue (RGB) color value for each display element in the array pointed to by the lpaElements parameter.

Return Values
If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks
The SetSysColors function sends a WM_SYSCOLORCHANGE message to all windows to inform them of the change in color. It also directs Windows to repaint the affected portions of all currently visible windows.

The SetSysColors function changes the current Windows session only. The new colors are not saved when Windows terminates.