Developer

API Reference

IWidget_GetFormatString()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IWidget IWidget_SetFormatString
Description
A convenience inline function for retrieivng PROP_FORMATSTRING with IWidget_GetProperty(). This inline retrieves the format string used by the DateTimeWidget to format the date or time for display.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget object.
  • ppwFormat
    []:
    [out] Pointer to an AECHAR format string.
Interface
Prototype
   int IWidget_GetFormatString(IWidget *pif, const AECHAR **ppwFormat);
Return
AEE_SUCCESS : The widget handled the PROP_FORMATSTRING property. AEE_EFAILED : Otherwise.
Side Effect
None
Comment
None
  • Follow