set_colored ( : : WindowHandle, NumberOfColors : )

Set multiple output colors.

set_colored is a shortcut for certain set_color calls. It allows the user to display a region set in different colors. NumberOfColors defines the number of colors that are used. Valid values for NumberOfColors can be queried with query_colored. Furthermore, the list of available colors can be set with the procedure set_system(::'graphic_colors',...:). This must be done before opening the first output window.


Parameters

WindowHandle (input_control)
window -> integer
Window_id.

NumberOfColors (input_control)
integer -> integer
Number of output colors.
Default value: 12
List of values: 3, 6, 12


Result

set_colored returns 2 (H_MSG_TRUE) if NumberOfColors is correct and the window is valid. Otherwise an exception handling is raised.


Parallelization Information

set_colored is reentrant, local, and processed without parallelization.


Possible Predecessors

query_colored, set_color


Possible Successors

disp_region


See also

query_colored, set_color, disp_region


Module

System



Copyright © 1996-2005 MVTec Software GmbH