Tao.Platform.Windows SDK Documentation

Winmm.joyGetThreshold Method 

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

[Visual Basic]
Public Shared Function joyGetThreshold( _
   ByVal uJoyID As Integer, _
   ByVal puThreshold As IntPtr _
) As Integer
[C#]
public static int joyGetThreshold(
   int uJoyID,
   IntPtr puThreshold
);

Parameters

uJoyID
Identifier of the joystick. Valid values for uJoyID range from zero (JOYSTICKID1) to 15, except for Windows NT 4.0. For Windows NT 4.0, valid values are limited to JOYSTICKID1 and JOYSTICKID2.
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.

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.

See Also

Winmm Class | Tao.Platform.Windows Namespace