Developer

API Reference

IForm_SetText()

Brew Release
Brew MP 1.0.2
See Also
IForm Widget Events
Description
This function will set the value of a text-based form property -- i.e., those properties that contain a pointer to an AECHAR string as its value, such as the title or softkey properties.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • fid
    []:
    [in] Identifies the form property to be set.
  • txt
    []:
    [in] Const pointer to the text that will be referenced by the 'fid' property.
Interface
Prototype
   int IForm_SetText(IForm *pif, uint16 fid, const AECHAR *txt);
Return
AEE_SUCCESS : If the form is able to set the specified form property. AEE_EFAILED : If the specified form property could not be set.
Side Effect
Calling IForm_SetText() will send an EVT_WDG_SETPROPERTY event to the form, requesting that the 'fid' property be set.
Comment
Only the following form properties should be set using IForm_SetText():
       FID_TITLE
       FID_SOFTKEY1
       FID_SOFTKEY2

Attempting to set properties not listed above will yield unexpected results.
  • Follow