Share via


joyGetPos

The joyGetPos function queries a joystick for its position and button status.

MMRESULT joyGetPos(
  UINT uJoyID,  
  LPJOYINFO pji 
);

Parameters

uJoyID

Identifier of the joystick to be queried. 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.

pji

Pointer to a JOYINFO structure that contains the position and button status of the joystick.

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.
JOYERR_UNPLUGGED The specified joystick is not connected to the system.

Remarks

For devices that have four to six axes of movement, a point-of-view control, or more than four buttons, use the joyGetPosEx function.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Mmsystem.h; include Windows.h.
**  Library:** Use Winmm.lib.

See Also

Joysticks, Multimedia Joystick Functions, JOYINFO, joyGetPosEx