joyGetThreshold

Syntax

WORD joyGetThreshold(wId, lpwThreshold)

This function queries the current movement threshold of a joystick device.

Parameters

WORD wId

Identifies the joystick device to be queried. This value is either JOYSTICKID1 or JOYSTICKID2.

LPWORD lpwThreshold

Specifies a far pointer to a WORD variable that is filled with the movement threshold value.

Return Value

Returns JOYERR_NOERROR if successful. Otherwise, returns one of the following error codes:

MMSYSERR_NODRIVER

The joystick driver is not present.

JOYERR_PARMS

The specified joystick device ID wId is invalid.

Comments

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.

See Also

joySetThreshold