Skip to content

get_shapeGetShapeGetShapeget_shapeT_get_shape🔗

Short description🔗

get_shapeGetShapeGetShapeget_shapeT_get_shape — Get the current region output shape.

Signature🔗

get_shape( window WindowHandle, out string DisplayShape )void GetShape( const HTuple& WindowHandle, HTuple* DisplayShape )static void HOperatorSet.GetShape( HTuple windowHandle, out HTuple displayShape )def get_shape( window_handle: HHandle ) -> str

Herror T_get_shape( const Htuple WindowHandle, Htuple* DisplayShape )

HString HWindow::GetShape( ) const

string HWindow.GetShape( )

Description🔗

get_shapeGetShape returns the shape in which regions are displayed. The available shapes can be queried with query_shapeQueryShape and then changed with set_shapeSetShape.

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.

DisplayShapedisplayShapedisplay_shape (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Current region output shape.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

query_shapeQueryShape

Possible successors

set_shapeSetShape, disp_regionDispRegion

See also

set_shapeSetShape, query_shapeQueryShape, disp_regionDispRegion

Module🔗

Foundation