get_line_styleT_get_line_styleGetLineStyleGetLineStyleget_line_style (Operator)

Name

get_line_styleT_get_line_styleGetLineStyleGetLineStyleget_line_style — Get the current graphic mode for contours.

Signature

get_line_style( : : WindowHandle : Style)

Description

get_line_styleget_line_styleGetLineStyleGetLineStyleGetLineStyleget_line_style returns the display mode for contours when displaying regions. It is used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLineDispLinedisp_line, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygondisp_polygon, etc. StyleStyleStyleStylestylestyle is set with the operator set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyleset_line_style. StyleStyleStyleStylestylestyle is only important for displaying the contour of objects, especially if a line style was set with set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyleset_line_style.

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.

StyleStyleStyleStylestylestyle (output_control) integer-array → (integer)

Template for contour display.

Result

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

Module

Foundation

Operators