Admin Production ni-theme
Current Publication

ColorPicker_SetFixedColor

LabWindows/CVI

ColorPicker_SetFixedColor

int ColorPicker_SetFixedColor (int panel, int control, int index, int color);

Purpose

Sets the value of a specific fixed color cell.

Parameters

Input
Name Type Description
panel int The specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
control int The ID you specified as the canvas parameter in the ColorPicker_Convert function call. This value must be the same as the defined constant, located in the .uir header file, that you assigned to the original canvas control.
index int The zero-based index of the color cell you are referencing.
color int Color to set. Specify the color as an RGB value, which is a 4-byte integer with the hexadecimal format 0x00RRGGBB. RR, GG, and BB are the respective red, green, and blue components of the color value.

You also can use the User Interface Library function, MakeColor, to create an RGB value from red, green, and blue color components.

Return Value

Name Type Description
status int Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Additional Information

Library: Color Picker Control

Include file: custctrl\color_picker.h

LabWindows/CVI compatibility: LabWindows/CVI 9.0 and later

Example

Refer to apps\iconedit\iconedit.cws for an example of using the ColorPicker_SetFixedColor function.