Developer

API Reference

IWidget_SetFormatString()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_GetFormatString
Description
A convenience inline function for setting PROP_FORMATSTRING with IWidget_SetProperty(). Sets the format string
Parameters
  • pif
    []:
    [in] Pointer to the IWidget object.
  • pwFormat
    []:
    [in] Pointer to an AECHAR format string.
Interface
Prototype
   int IWidget_SetFormatString(IWidget *pif, const AECHAR *pwFormat);
Return
AEE_SUCCESS : The widget handled the PROP_FORMATSTRING.property AEE_EFAILED : Otherwise.
Side Effect
Setting a format string may cause the date/time widget to initialize itself with an entirely new set of fields.
Comment
Since setting a format string may cause the date/time widget to display a completely different field presentation, it is recommended that IWidget_GetPreferredExtent() and IWidget_SetExtent() be called on the widget after setting this property.
  • Follow