Share via

CTime::Format

  • Article

CString Format( LPCTSTR pFormat ) const;

CString Format( UINT nFormatID ) const;

Return Value

A CString that contains the formatted time.

Parameters

pFormat

A formatting string similar to the printf formatting string. Formatting codes, preceded by a percent (%) sign, are replaced by the corresponding CTime component. Other characters in the formatting string are copied unchanged to the returned string. See the run-time function for details. The value and meaning of the formatting codes for Format are listed below:

  • %D   Total days in this CTime

  • %H   Hours in the current day

  • %M   Minutes in the current hour

  • %S   Seconds in the current minute

  • %%   Percent sign

nFormatID

The ID of the string that identifies this format.

Remarks

Call this member function to create a formatted representation of the date/time value. If the status of this CTime object is null, the return value is an empty string. If the status of CTime is invalid, the return value is an empty string.

Example

// example for CTime::Format and CTime::FormatGmt
CTime t( 1999, 3, 19, 22, 15, 0 );
// 10:15PM March 19, 1999
CString s = t.Format( "%A, %B %d, %Y" );
ASSERT( s == "Friday, March 19, 1999" );

CTime Overview |  Class Members |  Hierarchy Chart

See Also   CTime::FormatGmt