query_paintT_query_paintQueryPaintQueryPaintquery_paint (Operator)

Name

query_paintT_query_paintQueryPaintQueryPaintquery_paint — Query the gray value display modes.

Signature

query_paint( : : WindowHandle : Mode)

Description

query_paintquery_paintQueryPaintQueryPaintQueryPaintquery_paint returns the names of all gray value display modes (e.g., 'gray', '3d_plot', etc.) for the output window. These modes are used by set_paintset_paintSetPaintSetPaintSetPaintset_paint. query_paintquery_paintQueryPaintQueryPaintQueryPaintquery_paint only returns the names of the display values, not the additional parameters that may be necessary for some modes.

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.

ModeModeModeModemodemode (output_control) string-array → (string)

Gray value display mode names.

Result

query_paintquery_paintQueryPaintQueryPaintQueryPaintquery_paint returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Successors

get_paintget_paintGetPaintGetPaintGetPaintget_paint, set_paintset_paintSetPaintSetPaintSetPaintset_paint, disp_imagedisp_imageDispImageDispImageDispImagedisp_image

Module

Foundation

Operators