COleDateTime::SetDateTime
Sets the date and time of this COleDateTime object.
int SetDateTime(
int nYear,
int nMonth,
int nDay,
int nHour,
int nMin,
int nSec
) throw( );
Parameters
- nYear, nMonth, nDay, nHour, nMin, nSec
Indicate the date and time components to be copied into this COleDateTime object.
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.
Remarks
See the following table for bounds for the parameter values:
Parameter |
Bounds |
|---|---|
nYear |
100 – 9999 |
nMonth |
1 – 12 |
nDay |
0 – 31 |
nHour |
0 – 23 |
nMin |
0 – 59 |
nSec |
0 – 59 |
If the day of the month overflows, it is converted to the correct day of the next month and the month and/or year is incremented accordingly. A day value of zero indicates the last day of the previous month. The behavior is the same as SystemTimeToVariantTime Function.
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:
nHour |
nMin |
nSec |
Value |
|---|---|---|---|
1 |
3 |
3 |
01:03:03 |
23 |
45 |
0 |
23:45:00 |
25 |
30 |
0 |
Invalid |
9 |
60 |
0 |
Invalid |
Here are some examples of date values:
nYear |
nMonth |
nDay |
Value |
|---|---|---|---|
1995 |
4 |
15 |
15 April 1995 |
1789 |
7 |
14 |
17 July 1789 |
1925 |
2 |
30 |
Invalid |
10000 |
1 |
1 |
Invalid |
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:
For more information about the bounds for COleDateTime values, see the article Date and Time: Automation Support.
Example
See the example for GetStatus.
Requirements
Header: atlcomtime.h