set_coloredT_set_coloredSetColoredSetColoredset_colored (Operator)

Name

set_coloredT_set_coloredSetColoredSetColoredset_colored — Set multiple output colors.

Signature

set_colored( : : WindowHandle, NumberOfColors : )

Description

set_coloredset_coloredSetColoredSetColoredSetColoredset_colored is a shortcut for certain set_colorset_colorSetColorSetColorSetColorset_color calls. It allows the user to display a region set in different colors. NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors defines the number of colors that are used. Valid values for NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors can be queried with query_coloredquery_coloredQueryColoredQueryColoredQueryColoredquery_colored.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors (input_control) integer → (integer)

Number of output colors.

Default: 12

List of values: 3, 6, 12

Result

set_coloredset_coloredSetColoredSetColoredSetColoredset_colored returns 2 ( H_MSG_TRUE) if NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

query_coloredquery_coloredQueryColoredQueryColoredQueryColoredquery_colored, set_colorset_colorSetColorSetColorSetColorset_color

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

See also

query_coloredquery_coloredQueryColoredQueryColoredQueryColoredquery_colored, set_colorset_colorSetColorSetColorSetColorset_color, disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region

Module

Foundation