CoreWindow.GetKeyState(VirtualKey) Method

Reference

Definition

Namespace:: Windows.UI.Core

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Retrieves the state of a virtual key.

public:
 virtual CoreVirtualKeyStates GetKeyState(VirtualKey virtualKey) = GetKeyState;

CoreVirtualKeyStates GetKeyState(VirtualKey const& virtualKey);

public CoreVirtualKeyStates GetKeyState(VirtualKey virtualKey);

function getKeyState(virtualKey)

Public Function GetKeyState (virtualKey As VirtualKey) As CoreVirtualKeyStates

Parameters

virtualKey: VirtualKey

The virtual key for which state is returned.

Returns

CoreVirtualKeyStates

The flags indicating the current state of the supplied virtual key when the input event fired.

Note

For WinUI 3 apps, this method returns null. Use Microsoft.UI.Input.InputKeyboardSource.GetKeyStateForCurrentThread instead.

See Windows Runtime APIs not supported in desktop apps.

Implements

GetKeyState(VirtualKey)

Remarks

All keys support the Locked state (not just the standard Caps Lock and Num Lock keys).

Applies to

Jaa