get_mshapeT_get_mshapeGetMshapeGetMshapeget_mshape (Operator)

Name

get_mshapeT_get_mshapeGetMshapeGetMshapeget_mshape — Query the current mouse pointer shape.

Warning

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

Signature

get_mshape( : : WindowHandle : Cursor)

Description

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

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

Window handle.

CursorCursorCursorcursorcursor (output_control) string → (string)

Mouse pointer name.

Result

get_mshapeget_mshapeGetMshapeGetMshapeget_mshape returns the value 2 ( H_MSG_TRUE) .

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window, query_mshapequery_mshapeQueryMshapeQueryMshapequery_mshape

Possible Successors

set_mshapeset_mshapeSetMshapeSetMshapeset_mshape

Module

Foundation

Operators