#include <e32std.h>
| class TDateTime |
| Public Member Functions | |
|---|---|
| TDateTime() | |
| TDateTime(TInt, TMonth, TInt, TInt, TInt, TInt, TInt) | |
| TInt | Day() |
| TInt | Hour() |
| TInt | MicroSecond() |
| TInt | Minute() |
| TMonth | Month() |
| TInt | Second() |
| IMPORT_C TInt | Set(TInt, TMonth, TInt, TInt, TInt, TInt, TInt) |
| IMPORT_C TInt | SetDay(TInt) |
| IMPORT_C TInt | SetHour(TInt) |
| IMPORT_C TInt | SetMicroSecond(TInt) |
| IMPORT_C TInt | SetMinute(TInt) |
| IMPORT_C TInt | SetMonth(TMonth) |
| IMPORT_C TInt | SetSecond(TInt) |
| IMPORT_C TInt | SetYear(TInt) |
| IMPORT_C TInt | SetYearLeapCheck(TInt) |
| TInt | Year() |
A date and time object in which the individual components are accessible in human-readable form.
The individual components are: year, month, day, hour, minute, second and microsecond.
These components are stored as integers and all except the year are checked for validity when a TDateTime is constructed or assigned new values.
This class only supports getting and setting the entire date/time or any component of it. It does not support adding or subtracting intervals to or from a time. For functions which manipulate times, use class TTime.
See also: TTime
| IMPORT_C | TDateTime | ( | TInt | aYear, |
| TMonth | aMonth, | |||
| TInt | aDay, | |||
| TInt | aHour, | |||
| TInt | aMinute, | |||
| TInt | aSecond, | |||
| TInt | aMicroSecond | |||
| ) | ||||
Constructs the TDateTime object with the seven fields which comprise a date and time.
| Parameter | Description |
|---|---|
| aYear | The year. No check is made for validity. |
| aMonth | The month. Range is EJanuary to EDecember. |
| aDay | The day. Range is zero to number of days in month minus one. |
| aHour | The hour. Range is 0 to 23. |
| aMinute | The minute. Range is 0 to 59. |
| aSecond | The second. Range is 0 to 59 |
| aMicroSecond | The microsecond. Range is 0 to 999999 |
| TInt | Day | ( | ) | const [inline] |
Gets the day component of the date/time.
Returns: The day. Offset from zero, so add one before displaying the day number.
| TInt | MicroSecond | ( | ) | const [inline] |
Gets the microsecond component of the date/time.
Returns: The microsecond.
| TMonth | Month | ( | ) | const [inline] |
Gets the month component of the date/time.
Returns: The month. EJanuary to EDecember. Offset from zero, so add one before displaying the month number.
| IMPORT_C TInt | Set | ( | TInt | aYear, |
| TMonth | aMonth, | |||
| TInt | aDay, | |||
| TInt | aHour, | |||
| TInt | aMinute, | |||
| TInt | aSecond, | |||
| TInt | aMicroSecond | |||
| ) | ||||
Sets all date and time components.
Note:
1. When setting the day and month, subtract one because the ranges are offset from zero.
2. If the function returns an error, only those fields preceding the field which caused the error will be changed. For example, if the hour is out of range, the year, month and day will be set, all other components will remain unchanged.
| Parameter | Description |
|---|---|
| aYear | Year. No check is made on its validity, except that if the date is set to February 29th, the year can only be set to a leap year, otherwise an error is returned. |
| aMonth | Month. The valid range is EJanuary to EDecember. If an attempt is made to set an invalid month, or if the current day number in the month is greater than or equal to the number of days in the new month, an error is returned. |
| aDay | The number of the day within the month, offset from zero. If greater than or equal to the total number of days in the month,an error is returned. |
| aHour | Hour. Range is 0 to 23. |
| aMinute | Minute. Range is 0 to 59. |
| aSecond | Second. Range is 0 to 59. |
| aMicroSecond | Microsecond. Range is 0 to 999999. |
Returns: KErrNone if successful, KErrGeneral if not.
Sets the month component of the date/time.
| Parameter | Description |
|---|---|
| aMonth | The month to be set. The range is from EJanuary to EDecember. If an attempt is made to set an invalid month, or if the current day number in the month is greater than or equal to the number of days in the new month, an error is returned. |
Returns: KErrNone if successful, KErrGeneral if not.
Sets the year without a leap year check.
No check is made on the validity of the year except that if the current date is February 29th, the year can only be changed to another leap year, otherwise an error is returned.
| Parameter | Description |
|---|---|
| aYear | The year. |
Returns: KErrNone if successful, KErrGeneral if not.
Sets the year with a leap year check.
Unlike SetYear(), if the date is the 29th February, this function allows the year to be set to a non-leap year. In this case, the date is reset to the 28th February.
See also: TDateTime::SetYear
| Parameter | Description |
|---|---|
| aYear | The year. |
Returns: KErrNone if successful, KErrGeneral if not.
| TInt | Year | ( | ) | const [inline] |
Gets the year component of the date/time.
A negative value indicates a BC date.
Returns: The year