Developer

API Reference

IWidget_GetTextLimit()

Brew Release
Brew MP 1.0.2
See Also
- IWidget
- IWidget_GetPropInt()
- IWidget_SetTextLimit()
Description
This function is used to retrieve the maximum number of characters that can be entered into the given text widget. For example, a text widget that invites the user to enter a 5-digit postal ZIP code would set its maximum number of characters to 5, and return this value in response to IWidget_GetTextLimit(). The limit, though set on the text widget, is actually observed by the attached controller as the user enters text.
Parameters
  • pif
    []:
    [in] Pointer to the text widget object.
  • pnMaxChars
    []:
    [out] A pointer to an int into which the text widget will copy the character limit to be observed by the text widget's controller.
Interface
Prototype
   int IWidget_GetTextLimit(IWidget *pif, int *pnMaxChars)
Return
   AEE_SUCCESS - If BREW was able to successfully retrieve the text limit
   AEE_EFAILED - If the text limit could not be retrieved
Side Effect
IWidget_GetTextLimit() calls IWidget_GetPropInt() to retrieve the PROP_LIMITTEXT property.
Comment
None
  • Follow