CoreWindow.GetCurrentKeyEventDeviceId CoreWindow.GetCurrentKeyEventDeviceId CoreWindow.GetCurrentKeyEventDeviceId CoreWindow.GetCurrentKeyEventDeviceId Method

Definition

Retrieves the unique ID for the input device that generated this key event.

GetCurrentKeyEventDeviceId is not supported for all input devices.

public : Platform::String GetCurrentKeyEventDeviceId()
winrt::hstring GetCurrentKeyEventDeviceId() const;
public string GetCurrentKeyEventDeviceId()
Public Function GetCurrentKeyEventDeviceId() As string

Returns

string string

A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.

After a key event is processed, this method returns an empty string.

Additional features and requirements

Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Use GetCurrentKeyEventDeviceId to differentiate between devices that can generate key events, such as multiple Xbox controllers. The device id is useful for associating the input device with a specific user account.

To get a valid device ID, this method must be called from your KeyUp and KeyDown event handlers.