get_mshapeget_mshapeGetMshapeGetMshape (Operator)

Name

get_mshapeget_mshapeGetMshapeGetMshape — Query the current mouse pointer shape.

Signature

get_mshape( : : WindowHandle : Cursor)

get_mshapeget_mshapeGetMshapeGetMshapeGetMshape returns the name of the pointer shape set for the window. The mouse pointer shape can be used in the operator set_mshapeset_mshapeSetMshapeSetMshapeSetMshape.

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 → (integer)

Window handle.

CursorCursorCursorCursorcursor (output_control) string → (string)

Mouse pointer name.

Result

get_mshapeget_mshapeGetMshapeGetMshapeGetMshape returns the value 2 (H_MSG_TRUE).

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowOpenWindow, query_mshapequery_mshapeQueryMshapeQueryMshapeQueryMshape

Possible Successors

set_mshapeset_mshapeSetMshapeSetMshapeSetMshape

Module

Foundation

Operators