Operator Reference

get_line_styleT_get_line_styleGetLineStyleGetLineStyleget_line_style (Operator)

get_line_styleT_get_line_styleGetLineStyleGetLineStyleget_line_style — Get the current graphic mode for contours.

Signature

get_line_style( : : WindowHandle : Style)

Herror T_get_line_style(const Htuple WindowHandle, Htuple* Style)

void GetLineStyle(const HTuple& WindowHandle, HTuple* Style)

HTuple HWindow::GetLineStyle() const

static void HOperatorSet.GetLineStyle(HTuple windowHandle, out HTuple style)

HTuple HWindow.GetLineStyle()

def get_line_style(window_handle: HHandle) -> Sequence[int]

Description

get_line_styleget_line_styleGetLineStyleGetLineStyleget_line_style returns the display mode for contours when displaying regions. It is used by operators like disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_linedisp_lineDispLineDispLinedisp_line, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon, etc. StyleStyleStylestylestyle is set with the operator set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style. StyleStyleStylestylestyle is only important for displaying the contour of objects, especially if a line style was set with set_line_styleset_line_styleSetLineStyleSetLineStyleset_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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

StyleStyleStylestylestyle (output_control)  integer-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Template for contour display.

Result

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

See also

set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation