Developer

API Reference

IForm_GetCancelKey()

Brew Release
Brew MP 1.0.2
See Also
Description
This function will retrieve the virtual key code that the form recognizes as the cancel key -- i.e. the key that, when pressed, will generate an EVT_FORM_CANCEL event, returning that key in the 'pwKey' passed into the function.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • pwKey
    []:
    [out] Pointer to a 16-bit integer into which the virtual key code of the form's cancel key will be copied.
Interface
Prototype
   int IForm_GetCancelKey(IForm *pif, uint16 *pwKey); 
Return
AEE_SUCCESS : If the form is able to successfully retrieve the cancel key. AEE_EFAILED : If the cancel key could not be retrieved.
Side Effect
Calling IForm_GetCancelKey() effectively queries the form to retrieve the FID_CANCELKEY property.
Comment
None
  • Follow