Share via

GetAsyncShiftFlags (Compact 2013)

  • Article

3/28/2014

This function provides asynchronous state information about the virtual key that is passed in. It also provides the current state information on the shift flags provided by KEY_STATE_FLAGS.

Syntax

KEY_STATE_FLAGS GetAsyncShiftFlags(
  UINT VKey
);

Parameters

  • VKey
    [in] Specifies a virtual-key code.

Return Value

If the function succeeds, the low-order bits of the return value specify the current state information about the virtual key that is passed in. The high-order bits track the current shift state on a key-by-key basis. For more information on retrieving the information from the return value, see the topic KEY_STATE_FLAGS.

Passing in an invalid virtual-key code will cause the function to return 0 and set the last-error code to ERROR_INVALID_PARAMETER. Since 0 is also a valid return value, you must clear the last-error code before calling this function in order to check on the success of a call to GetAsyncShiftFlags.

Requirements

Header

pwinuser.h

Library

Kbdui.lib

See Also

Reference

Keyboard Functions
Virtual Key Codes
GetKeyState
MapVirtualKey

Other Resources

KEY_STATE_FLAGS