query_mshapeQueryMshapeQueryMshapequery_mshapeT_query_mshape

HALCON ScriptCpp++.NETPythonC

Short description

query_mshapeQueryMshapeQueryMshapequery_mshapeT_query_mshape — Query all available mouse pointer shapes.

Warning

This operator does not work in an HDevelop graphics window opened with dev_open_window.

Signature

query_mshape( window WindowHandle, out string ShapeNames )void QueryMshape( const HTuple& WindowHandle, HTuple* ShapeNames )static void HOperatorSet.QueryMshape( HTuple windowHandle, out HTuple shapeNames )def query_mshape( window_handle: HHandle ) -> Sequence[str]

Herror T_query_mshape( const Htuple WindowHandle, Htuple* ShapeNames )

HTuple HWindow::QueryMshape( ) const

HTuple HWindow.QueryMshape( )

Description

query_mshapeQueryMshape returns the names of all available mouse pointer shapes for the window. These can be used in the operator set_mshapeSetMshape. If no mouse pointers are available, the empty tuple is returned.

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.

ShapeNamesshapeNamesshape_names (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Available mouse pointer names.

Result

query_mshapeQueryMshape returns the value 2 (H_MSG_TRUE).

Combinations with other operators

Combinations

Possible predecessors

open_windowOpenWindow, get_mshapeGetMshape

Possible successors

set_mshapeSetMshape

See also

set_mshapeSetMshape, get_mshapeGetMshape

Module

Foundation