CoreWindow.GetKeyState(VirtualKey) Method

Definition

Namespace:

Windows.UI.Core

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)

See also

• <xref:Windows.UI.Core.CoreVirtualKeyStates%0a*+M%3aWindows.UI.Core.CoreWindow.GetAsyncKeyState(Windows.System.VirtualKey)%0a*+%5bInputKeyboardSource.GetKeyStateForCurrentThread%5d(%2fwindows%2fwindows-app-sdk%2fapi%2fwinrt%2fmicrosoft.ui.input.inputkeyboardsource.getkeystateforcurrentthread)>