CDateTimeCtrl::SetFormat

Article
12/01/2015

Sets the display of a date and time picker control in accordance with a given format string.

Syntax

      BOOL SetFormat(
   LPCTSTR pstrFormat 
);

Parameters

pstrFormat
A pointer to a zero-terminated format string that defines the desired display. Setting this parameter to NULL will reset the control to the default format string for the current style.

Return Value

Nonzero if successful; otherwise 0.

Note

User input does not determine success or failure for this call.

Remarks

This member function implements the behavior of the Win32 message DTM_SETFORMAT, as described in the Windows SDK.

Example

// The control will create itself with a format that matches the 
// locale setting in Control Panel. But we can force a particular 
// format with a call to SetFormat(). This call forces the format 
// dd-MMM-yy, which would show 03-APR-98 for April 3rd, 1998.
m_DateTimeCtrl.SetFormat(_T("dd-MMM-yy"));

Requirements

Header: afxdtctl.h