joyGetThreshold function (joystickapi.h)

Article
02/22/2024

The joyGetThreshold function queries a joystick for its current movement threshold.

Syntax

MMRESULT joyGetThreshold(
  UINT   uJoyID,
  LPUINT puThreshold
);

Parameters

uJoyID

Identifier of the joystick. Valid values for uJoyID range from zero (JOYSTICKID1) to 15.

puThreshold

Pointer to a variable that contains the movement threshold value.

Return value

Returns JOYERR_NOERROR if successful or one of the following error values.

Return code	Description
MMSYSERR_NODRIVER	The joystick driver is not present.
MMSYSERR_INVALPARAM	An invalid parameter was passed.

Remarks

The movement threshold is the distance the joystick must be moved before a joystick position-change message (MM_JOY1MOVE, MM_JOY1ZMOVE, MM_JOY2MOVE, or MM_JOY2ZMOVE) is sent to a window that has captured the device. The threshold is initially zero.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	joystickapi.h (include Windows.h)
Library	Winmm.lib
DLL	Winmm.dll