set_coloredT_set_coloredSetColoredSetColoredset_colored (Operator)
Name
set_coloredT_set_coloredSetColoredSetColoredset_colored — Set multiple output colors.
Signature
Description
set_coloredset_coloredSetColoredSetColoredset_colored is a shortcut for certain
set_colorset_colorSetColorSetColorset_color calls. It allows the user to display a region
set in different colors. NumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors defines the
number of colors that are used. Valid values for
NumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors can be queried with
query_coloredquery_coloredQueryColoredQueryColoredquery_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
WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
NumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of output colors.
Default:
12
List of values:
3, 6, 12
Result
set_coloredset_coloredSetColoredSetColoredset_colored returns 2 (
H_MSG_TRUE)
if NumberOfColorsNumberOfColorsNumberOfColorsnumberOfColorsnumber_of_colors
is correct and the window is valid. Otherwise an exception is
raised.
Possible Predecessors
query_coloredquery_coloredQueryColoredQueryColoredquery_colored,
set_colorset_colorSetColorSetColorset_color
Possible Successors
disp_regiondisp_regionDispRegionDispRegiondisp_region
See also
query_coloredquery_coloredQueryColoredQueryColoredquery_colored,
set_colorset_colorSetColorSetColorset_color,
disp_regiondisp_regionDispRegionDispRegiondisp_region
Module
Foundation