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

Developer

API Reference

IDATECTL_GETDATESTRING()

Brew Release
Brew MP 1.0.2
See Also
IDateCtl IDATECTL_GetDayString IDATECTL_GetMonthString
Description
This function gets the date string in the specified format.
Params
pIDateCtl
[]:
pointer to the IDateCtl Interface object.
pBuffer
[]:
placeholder for date string.
nMaxSize
[]:
size of the input buffer (pBuffer) in bytes.
pnChars
[]:
placeholder for the number of characters written in pBuffer.
dwDateFormat
[]:
format of the date string. Use one of the date string formats
DFMT_DD_MONTH_YYYY
[]:
18 July 2000
DFMT_DD_MON_YYYY
[]:
18 Jul 2000
DFMT_DD_MON_YY
[]:
18 Jul ‘00
DFMT_MONTH_DD_YYYY
[]:
July 18, 2000
DFMT_MON_DD_YYYY
[]:
Jul 18, 2000
DFMT_MON_DD_YY
[]:
Jul 18, ‘00
DFMT_MM_DD_YYYY
[]:
10/15/2000
DFMT_DD_MM_YYYY
[]:
15/10/2001
DFMT_YYYY_MM_DD
[]:
2001/6/1
DFMT_INT_YYYY_MM_DD
[]:
2001.06.01
Interface
  • IDATECTL
Prototype
  •     boolean IDATECTL_GetDateString
        (
          IDateCtl * pIDateCtl,
          AECHAR * pBuffer,
          unsigned int nMaxSize,
          unsigned int * pnChars,
          uint32 dwDateFormat
        );
    
Return
  • TRUE: if successful. FALSE: if unsuccessful.
Side Effect
  • None.
Comments
The date string formats for parameter dwDateFormat are mutually exclusive.