Skip to content

get_line_styleGetLineStyleGetLineStyleget_line_styleT_get_line_style🔗

Short description🔗

get_line_styleGetLineStyleGetLineStyleget_line_styleT_get_line_style — Get the current graphic mode for contours.

Signature🔗

get_line_style( window WindowHandle, out integer Style )void GetLineStyle( const HTuple& WindowHandle, HTuple* Style )static void HOperatorSet.GetLineStyle( HTuple windowHandle, out HTuple style )def get_line_style( window_handle: HHandle ) -> Sequence[int]

Herror T_get_line_style( const Htuple WindowHandle, Htuple* Style )

HTuple HWindow::GetLineStyle( ) const

HTuple HWindow.GetLineStyle( )

Description🔗

get_line_styleGetLineStyle returns the display mode for contours when displaying regions. It is used by operators like disp_regionDispRegion, disp_lineDispLine, disp_polygonDispPolygon, etc. Stylestylestyle is set with the operator set_line_styleSetLineStyle. Stylestylestyle is only important for displaying the contour of objects, especially if a line style was set with set_line_styleSetLineStyle.

Execution information🔗

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🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Stylestylestyle (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Template for contour display.

Result🔗

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

Combinations with other operators🔗

Combinations

See also

set_line_styleSetLineStyle, disp_regionDispRegion

Module🔗

Foundation