GetDeviceStatus

  • Article

Retrieves the current status of an input device.

Syntax

GameInputDeviceStatus GetDeviceStatus(  
)

Parameters

This method has no parameters.

Return value

Type: GameInputDeviceStatus

The value returned is the enumeration type GameInputDeviceStatus.
The value returned may be a combination of the enumerated flag values from GameInputDeviceStatus.

Remarks

The returned GameInputDeviceStatus enumeration defines whether the device is connected, and the types of input and output that may be transmitted between the game and the device. If the GetDeviceStatus method is called when the device has been disconnected from the system, the GameInputDeviceNoStatus value is returned. You can use the GameInputDeviceStatus enumeration as a filter for the RegisterDeviceCallback method to react to specific changes in a device's state.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Overview of GameInput
GameInputDeviceStatus
RegisterDeviceCallback
IGameInputDevice