get_line_widthT_get_line_widthGetLineWidthGetLineWidthget_line_width (Operator)

Name

get_line_widthT_get_line_widthGetLineWidthGetLineWidthget_line_width — Get the current line width for contour display.

Signature

get_line_width( : : WindowHandle : Width)

Description

get_line_widthget_line_widthGetLineWidthGetLineWidthget_line_width returns the line width for region display in the window. It is used by operators like disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLinedisp_line, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon, etc. WidthWidthWidthwidthwidth is set with the operator set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width. WidthWidthWidthwidthwidth is only important for displaying the contour of objects.

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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

WidthWidthWidthwidthwidth (output_control) real → (real)

Current line width for contour display.

Result

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

Possible Successors

set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation

Operators