Developer

API Reference

IKeysConfig_GetKeyState()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IKeysConfig IKeysConfig_SetKeyState IKeysConfig_GetStickyKeys
Description
Returns the state of the queried sticky key (on or off).
Parameters
  • dwKey
    [in]:
    Modifier value of the key (KB_CAPSLOCK for ex).
  • pbState
    [out]:
    On return *pbState is set to TRUE if key is on, FALSE otherwise.
Interface
Prototype
int IKeysConfig_GetKeyState(IKeysConfig *piKeysConfig, uint32 dwKey, boolean *pbState);
Return
AEE_SUCCESS : bState contains state of queried key. AEE_EFAILED : if state is not supported for this key (ex. non-sticky key). AEE_EBADPARM : if bState is NULL.
Side Effect
None
Comment
None
  • Follow