API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IWIDGET_GETTEXTWIDGETTEXT()

Brew Release
Brew MP 1.0.2
See Also
- IWidget - AECHAR - IWidget_SetTextWidgetText()
Description
Retrieves the text stored in a text widget from that widget's text model. A pointer to the text is returned in the 'ppwTxt' parameter.
Params
pif
[]:
[in] Pointer to the IWidget object.
ppwTxt
[]:
[out] Pointer to an AECHAR pointer into which the function will return a pointer to the text currently contained in the text widget.
Interface
Prototype
  •    int IWidget_GetTextWidgetText(IWidget *pif, AECHAR **ppwTxt);
    
Return
  •    AEE_SUCCESS - If the text widget is able to successfully return a pointer to the text.
       AEE_EFAILED - If the text could not be accessed and returned.
    
Side Effect
  • None
Comments
The text pointer returned by IWidget_GetTextWidgetText() is the same pointer stored in the 'pwText' field of the TextInfo data structure maintained by the text model.