Creates a Color dialog box that enables the user to select a color.
Syntax
BOOL ChooseColor(
LPCHOOSECOLOR lpcc
);
Parameters
- lpcc
-
[in, out] 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
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.
Windows 95/98/Me: ChooseColorW is supported by the Microsoft Layer for Unicode (MSLU). To use this, you must add certain files to your application, as outlined in Microsoft Layer for Unicode on Windows 95/98/Me Systems.
Example
For an example, see Choosing a Color.
Function Information
| Minimum DLL Version | comdlg32.dll |
|---|
| Header | Declared in Commdlg.h, include Windows.h |
|---|
| Import library | Comdlg32.lib |
|---|
| Minimum operating systems |
Windows 95, Windows NT 3.1 |
|---|
| Unicode | Implemented as
ANSI and Unicode versions. |
|---|
See Also