Developer

API Reference

IForm_SetResText()

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, identifying the text as a resource stored in a BREW resource file. The form framework will load the specified text resource and assign a pointer to this text as the appropriate form property. For example, the text of a form's softkey widgets could be stored as a text resource in a particular file. An application could then set the text for either softkey one or softkey two by calling IForm_SetResText(), identifying the resource file name and ID of the text resource that would be used to set the FID_SOFTKEY1 or FID_SOFTKEY2 form properties. The form framework will comply by loading the text, assigning a pointer to this text as the form property, then notifying all listening objects that the softkey text has changed.
Parameters
  • p
    []:
    [in] Pointer to the IForm interface object.
  • f
    []:
    [in] Identifies the form property to be set by the contents of the specified resource.
  • r
    []:
    [in] Identifies the name of the resource file that contains the resource that contains the property text.
  • i
    []:
    [in] Identifies the resource that contains the text to be stored in the form's 'f' property.
Interface
Prototype
   int IForm_SetResText(IForm *p, uint16 f, const char *r, uint16 i); 
Return
AEE_SUCCESS : If the form is able to set the specified form property. Note, however, that this does NOT mean that BREW was able to successfully retrieve the resource from the resource file. Applications should be certain that 'resfile' is a valid BREW resource file and that resource 'id' actually exists. AEE_EFAILED : If the specified form property could not be set.
Side Effect
Calling IForm_SetResText() will send an EVT_WDG_SETPROPERTY event to the form, requesting that the 'f' property be set.
Comment
Applications should exercise care in calling IForm_SetResText(), making sure that the specified resource file and resource actually exist. Moreover, IForm_SetResText() is not intended to be a generalized form of setting form properties from data contained in a resource file. Only the following form properties may be set from text-based resource data:
       FID_TITLE
       FID_SOFTKEY1
       FID_SOFTKEY2

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