get_line_styleT_get_line_styleGetLineStyleGetLineStyle (Operator)

Name

get_line_styleT_get_line_styleGetLineStyleGetLineStyle — Get the current graphic mode for contours.

Signature

get_line_style( : : WindowHandle : Style)

Description

get_line_styleget_line_styleGetLineStyleGetLineStyleGetLineStyle returns the display mode for contours when displaying regions. It is used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygon, etc. StyleStyleStyleStylestyle is set with the operator set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle. StyleStyleStyleStylestyle is only important for displaying the contour of objects, especially if a line style was set with set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle.

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.

StyleStyleStyleStylestyle (output_control) integer-array → (integer)

Template for contour display.

Result

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

See also

set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation