ChooseColor function
Creates a Color dialog box that enables the user to select a color.
Syntax
BOOL WINAPI ChooseColor(
_Inout_ LPCHOOSECOLOR lpcc
);
Parameters
lpcc [in, out]
Type: LPCHOOSECOLORA pointer to a CHOOSECOLOR structure that contains information used to initialize the dialog box. When ChooseColor returns, this structure contains information about the user's color selection.
Return value
Type: BOOL
If the user clicks the OK button of the dialog box, the return value is nonzero. The rgbResult member of the CHOOSECOLOR structure contains the RGB color value of the color selected by the user.
If the user cancels or closes the Color dialog box or an error occurs, the return value is zero. To get extended error information, call the CommDlgExtendedError function, which can return one of the following values:
CDERR_DIALOGFAILURE
CDERR_FINDRESFAILURE
CDERR_MEMLOCKFAILURE
CDERR_INITIALIZATION
CDERR_NOHINSTANCE
CDERR_NOHOOK
CDERR_LOADRESFAILURE
CDERR_NOTEMPLATE
CDERR_LOADSTRFAILURE
CDERR_STRUCTSIZE
CDERR_MEMALLOCFAILURE
Remarks
The Color dialog box does not support palettes. The color choices offered by the dialog box are limited to the system colors and dithered versions of those colors.
You can provide a CCHookProc hook procedure for a Color dialog box. The hook procedure can process messages sent to the dialog box. To enable a hook procedure, set the CC_ENABLEHOOK flag in the Flags member of the CHOOSECOLOR structure and specify the address of the hook procedure in the lpfnHook member.
Examples
For an example, see Choosing a Color.
Requirements
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
Minimum supported server |
Windows 2000 Server [desktop apps only] |
Header |
Commdlg.h (include Windows.h) |
Library |
Comdlg32.lib |
DLL |
Comdlg32.dll |
Unicode and ANSI names |
ChooseColorW (Unicode) and ChooseColorA (ANSI) |
See also
Reference
Conceptual