Admin Production ni-theme
Current Publication

ColorPicker_SetActiveColorCell

LabWindows/CVI

ColorPicker_SetActiveColorCell

int ColorPicker_SetActiveColorCell (int panel, int control, int index, int type);

Purpose

Sets the color from a specific fixed or custom color cell or the transparent item as the active color.

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 or PICKER_VAL_TRANSPARENT for the transparent item.

PICKER_VAL_TRANSPARENT is valid only if the specified type is also PICKER_VAL_TRANSPARENT and the ATTR_PICKER_TRANSPARENT_ITEM_VISIBLE attribute is TRUE.
type int The type of cell the index parameter refers to. Valid values are PICKER_VAL_FIXED_COLOR, PICKER_VAL_CUSTOM_COLOR, and PICKER_VAL_TRANSPARENT.

PICKER_VAL_TRANSPARENT is valid only if the specified index is also PICKER_VAL_TRANSPARENT and the ATTR_PICKER_TRANSPARENT_ITEM_VISIBLE attribute is TRUE.

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