COleDateTime::SetDate

int SetDate( int nYear**, int** nMonth**, int** nDay );

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

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

Remarks

Call this member function to set the date and time of this COleDateTime object. The date is set to the specified values. The time is set to time 0, midnight.

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 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 date values:

To set both date and time, see COleDateTime::SetDateTime.

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

// set only the date, time set to midnight
dt.SetDate(1999, 3, 19);
ASSERT(dt.GetYear() == 1999);
ASSERT(dt.GetDay() == 19);
ASSERT(dt.GetMonth() == 3);
ASSERT(dt.GetHour() == 0);
ASSERT(dt.GetMinute() == 0);
ASSERT(dt.GetSecond() == 0);

// setting the time only resets the date to 1899!
dt.SetTime(22, 15, 0);
ASSERT(dt.GetYear() == 1899);
ASSERT(dt.GetDay() == 30);
ASSERT(dt.GetMonth() == 12);
ASSERT(dt.GetHour() == 22);
ASSERT(dt.GetMinute() == 15);
ASSERT(dt.GetSecond() == 0);

COleDateTime Overview |  Class Members |  Hierarchy Chart

See Also   COleDateTime::COleDateTime, COleDateTime::SetDateTime, COleDateTime::operator =, COleDateTime::GetStatus, COleDateTime::m_dt