WinSetSysColors - Parameters

hwndDeskTop (HWND) - input

Desktop-window handle.

HWND_DESKTOP

The desktop-window handle
Other
Specified desktop-window handle.

flOptions (ULONG) - input

Options.

LCOL_RESET

The system colors are all to be reset to default before processing the remainder of the data in this function.
LCOL_PURECOLOR
Color-dithering should not be used to create colors not available in the physical palette. If this option is set, only pure colors are used and no dithering is done.

ulFormat (ULONG) - input

Format of entries in the table, as follows.

LCOLF_INDRGB

Array of (index,RGB) values. Each pair of entries is 8-bytes long, comprising 4 bytes for the index, and 4 bytes for the color value. For system color indexes, see lStart.
LCOLF_CONSECRGB
Array of (RGB) values, corresponding to color indexes lStart upwards. Each entry is 4-bytes long.

lStart (LONG) - input

Starting system color index.

This parameter is applicable only if the ulFormat parameter is set to LCOLF_CONSECRGB.

The number of system colors (as defined below) is given by SYSCLR_CSYSCOLORS.

The following system color indexes are defined (each successive index is one larger than its predecessor):

SYSCLR_ENTRYFIELD

Entry field and list box background color.
SYSCLR_MENUDISABLEDTEXT
Entry field background color.
SYSCLR_MENUHILITE
Selected menu item text.
SYSCLR_MENUHILITEBGND
Selected menu item background.
SYSCLR_PAGEBACKGROUND
Notebook page background.
SYSCLR_FIELDBACKGROUND
Inactive scroll bar and default control background color.
SYSCLR_BUTTONLIGHT
Light push button (3D effect).
SYSCLR_BUTTONMIDDLE
Middle push button (3D effect).
SYSCLR_BUTTONDARK
Dark push button (3D effect).
SYSCLR_BUTTONDEFAULT
Push button.
SYSCLR_TITLEBOTTOM
Line drawn under title bar.
SYSCLR_SHADOW
Drop shadow for menus and dialogs.
SYSCLR_ICONTEXT
Text written under icons on the desktop.
SYSCLR_DIALOGBACKGROUND
Pop up dialog box background.
SYSCLR_HILITEFOREGROUND
Selection foreground.
SYSCLR_HILITEBACKGROUND
Selection background.
SYSCLR_INACTIVETITLETEXTBKGD
Background of inactive title text.
SYSCLR_ACTIVETITLETEXTBKGD
Background of active title text.
SYSCLR_INACTIVETITLETEXT
Inactive title text.
SYSCLR_ACTIVETITLETEXT
Active title text.
SYSCLR_OUTPUTTEXT
Output text.
SYSCLR_WINDOWSTATICTEXT
Static (nonselectable) text.
SYSCLR_SCROLLBAR
Active scroll bar background area.
SYSCLR_BACKGROUND
Desktop background.
SYSCLR_ACTIVETITLE
Active window title.
SYSCLR_INACTIVETITLE
Inactive window title.
SYSCLR_MENU
Menu background.
SYSCLR_WINDOW
Window background.
SYSCLR_WINDOWFRAME
Window frame (border line).
SYSCLR_MENUTEXT
Normal menu item text.
SYSCLR_WINDOWTEXT
Window text.
SYSCLR_TITLETEXT
Text in title bar, size box, scroll bar arrow box.
SYSCLR_ACTIVEBORDER
Border fill of active window.
SYSCLR_INACTIVEBORDER
Border fill of inactive window.
SYSCLR_APPWORKSPACE
Background of specific main windows.
SYSCLR_HELPBACKGROUND
Background of help panels.
SYSCLR_HELPTEXT
Help text.
SYSCLR_HELPHILITE
Highlighted help text.
SYSCLR_SHADOWHILITEBGND
Shadows of workplace object background highlight color.
SYSCLR_SHADOWHILITEFGND
Shadows of workplace object foreground highlight color.
SYSCLR_SHADOWTEXT
Shadows of workplace object text color.

ulTablen (ULONG) - input

Number of elements.

Number of elements supplied in alTable. This may be 0 if, for example, the color table is merely to be reset to the default. For LCOLF_INDRGB it must be an even number.

alTable (PLONG) - input

Table.

Start address of the application data area, containing the color-table definition data. The format depends on the value of ulFormat.

Each color value is a 4-byte integer, with a value of

(R * 65536) + (G * 256) + B

where:

R

is red intensity value
G
is green intensity value
B
is blue intensity value.
There are 8 bits for each primary; the maximum intensity for each primary is 255.

rc (BOOL) - returns

Success indicator.

TRUE

Successful completion
FALSE
Error occurred.

---

[Back: WinSetSysColors Return Value - rc]
[Next: WinSetSysColors - Remarks]