COleDateTime::SetDateTime

int SetDateTime( int nYear**, int** nMonth**, int** nDay**,int** nHour**, int** nMin**, int** nSec );

Return Value

Zero if the value of this COleDateTime object was set successfully; otherwise, 1. This return value is based on the DateTimeStatus enumerated type. For more information, see the SetStatus member function.

Parameters

nYear, nMonth, nDay, nHour, nMin, nSec

Indicate the date and time components to be copied into this COleDateTime object.

Remarks

Call this member function to set the date and time of this COleDateTime object.

See the following table for bounds for the parameter values:

The actual upper bound for nDay values varies based on the month and year. For months 1, 3, 5, 7, 8, 10, and 12, the upper bound is 31. For months 4, 6, 9, and 11, it is 30. For month 2, it is 28, or 29 in a leap year.

If the date or time value specified by the parameters is not valid, the status of this object is set to invalid and the value of this object is not changed.

Here are some examples of time values:

Here are some examples of date values:

To set the date only, see COleDateTime::SetDate. To set the time only, see COleDateTime::SetTime.

For information on member functions that query the value of this COleDateTime object, see the following member functions:

• GetDay

• GetMonth

• GetYear

• GetHour

• GetMinute

• GetSecond

• GetDayOfWeek

• GetDayOfYear

For more information about the bounds for COleDateTime values, see the article in Visual C++ Programmer’s Guide.

Example

See the example for GetStatus.

COleDateTime Overview |  Class Members |  Hierarchy Chart

See Also   COleDateTime::COleDateTime, COleDateTime::SetDate, COleDateTime::SetTime, COleDateTime::operator =, COleDateTime::GetStatus, COleDateTime::m_dt