Developer

API Reference

IKeysMapping_GetMapping()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IKeysMapping
Description
This function returns the mapping of the an AVK code and modifier combination to the intended character
Parameters
  • pIKeysMapping
    []:
    IKeysMapping interface object.
  • avk
    []:
    The key virtual code for which mapping is desired.
  • modifiers
    []:
    A bit mask of modifiers for which the mapping is desired (such as KB_LSHIFT) See AEEVCodes.h for a complete list of modifiers.
  • mapping
    [out]:
    On return, is set to the unicode value of the mapping for avk + modifiers.
Interface
Prototype
   int IKeysMapping_GetMapping(IKeysMapping *pIKeysMapping, uint16 avk, uint32 modifiers, AECHAR *mapping);
Return
AEE_SUCCESS : mapping found and successfully copied into "*mapping" AEE_EBADPARM : if mapping is NULL. AEE_EFAILED : if avk + modifiers combination does not have a defined mapping.
Side Effect
None.
Comment
None.
  • Follow