get_line_widthT_get_line_widthGetLineWidthGetLineWidth (Operator)

Name

get_line_widthT_get_line_widthGetLineWidthGetLineWidth — Get the current line width for contour display.

Signature

get_line_width( : : WindowHandle : Width)

Description

get_line_widthget_line_widthGetLineWidthGetLineWidthGetLineWidth returns the line width for region display in the window. It is used by operators like disp_regiondisp_regionDispRegionDispRegionDispRegion, disp_linedisp_lineDispLineDispLineDispLine, disp_polygondisp_polygonDispPolygonDispPolygonDispPolygon, etc. WidthWidthWidthWidthwidth is set with the operator set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth. 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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control) window → (handle)

Window handle.

WidthWidthWidthWidthwidth (output_control) real → (real)

Current line width for contour display.

Result

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

Possible Successors

set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth, set_line_styleset_line_styleSetLineStyleSetLineStyleSetLineStyle, disp_regiondisp_regionDispRegionDispRegionDispRegion

See also

set_line_widthset_line_widthSetLineWidthSetLineWidthSetLineWidth, disp_regiondisp_regionDispRegionDispRegionDispRegion

Module

Foundation