set_coloredT_set_coloredSetColoredSetColored (Operator)

Name

set_coloredT_set_coloredSetColoredSetColored — Set multiple output colors.

Signature

set_colored( : : WindowHandle, NumberOfColors : )

Description

set_coloredset_coloredSetColoredSetColoredSetColored is a shortcut for certain set_colorset_colorSetColorSetColorSetColor calls. It allows the user to display a region set in different colors. NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors defines the number of colors that are used. Valid values for NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors can be queried with query_coloredquery_coloredQueryColoredQueryColoredQueryColored.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

NumberOfColorsNumberOfColorsNumberOfColorsNumberOfColorsnumberOfColors (input_control) integer → (integer)

Number of output colors.

Default value: 12

List of values: 3, 6, 12

Result

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

Possible Predecessors

query_coloredquery_coloredQueryColoredQueryColoredQueryColored, set_colorset_colorSetColorSetColorSetColor

Possible Successors

disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

query_coloredquery_coloredQueryColoredQueryColoredQueryColored, set_colorset_colorSetColorSetColorSetColor, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation