joyGetThreshold

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

MMRESULT joyGetThreshold(
  UINT uJoyID,        
  LPUINT puThreshold  
);

Parameters

uJoyID
Identifier of the joystick (JOYSTICKID1 or JOYSTICKID2) to be queried.
puThreshold
Address of a variable that contains the movement threshold value.

Return Values

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

Value 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 WM_JOYMOVE message is sent to a window that has captured the device. The threshold is initially zero.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in mmsystem.h.
  Import Library: Use winmm.lib.

See Also

Joysticks Overview, Multimedia Joystick Functions