GetGlobalMouseState

int GetGlobalMouseState (int *panelHandle, int *xCoordinate, int *yCoordinate, int *leftButtonDown, int *rightButtonDown, int *keyModifiers);

Purpose

Obtains information about the state of the mouse cursor. xCoordinate and yCoordinate return the position of the mouse relative to the top, left corner of the screen.

Parameters

Output
Name Type Description
panelHandle integer Handle of the panel that the mouse is over.

panelHandle is 0 if the mouse is not over a panel.

You can pass NULL.
xCoordinate integer X-coordinate of the mouse cursor relative to the left edge of the screen.

You can pass NULL.
yCoordinate integer Y-coordinate of the mouse cursor relative to the top of the screen.

You can pass NULL.
leftButtonDown integer The state of the left mouse button.

0 if the left button is up. 1 if the left button is down.

You can pass NULL.
rightButtonDown integer The state of the right mouse button.

0 if the right button is up. 1 if the right button is down.

You can pass NULL.
keyModifiers integer State of the keyboard modifiers, in other words, the <Ctrl>, <Alt>, and <Shift> keys.

If no keys are down, the value is 0. Otherwise, the value is the bitwise OR of the appropriate key masks: VAL_MENUKEY_MODIFIER, VAL_UNDERLINE_MODIFIER, VAL_SHIFT_MODIFIER, and VAL_SHIFT_AND_MENUKEY.

You can pass NULL.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success