Developer

API Reference

IForm_SetSoftkey()

Brew Release
Brew MP 1.0.2
See Also
IForm Widget Events
Description
This function will set the text appearing on either of a form's softkey widgets, storing that text as a pointer to an AECHAR in the FID_SOFTKEY1 or FID_SOFTKEY2 property.
Parameters
  • p
    []:
    [in] Pointer to the IForm interface object.
  • i
    []:
    [in] Identifies the form property to be set. Pass FID_SOFTKEY1 to set the text of softkey one, or FID_SOFTKEY2 to set the text of softkey two.
  • t
    []:
    [in] Pointer to the text to appear on the specified softkey.
Interface
Prototype
   int IForm_SetSoftkey(IForm *p, uint16 i, AECHAR *t); 
Return
AEE_SUCCESS : If the form is able to set the softkey text AEE_EFAILED : If the softkey text could not be set.
Side Effect
Calling IForm_SetSoftkey() will send an EVT_WDG_SETPROPERTY event to the form, requesting that the FID_SOFTKEY1 or FID_SOFTKEY2 property be set.
Comment
Applications are encouraged to use IForm_SetSoftkey() as a shorthand method of setting the softkey text.
  • Follow