Simplifies the management of date/time information.
The Time class is available for programs that require time and date management in a multi-platform manner.
To get the current system time, use the Query() action.
Structure
The Time class consists of the following fields:
Access | Name | Type | Comment | |
| Day | INT | Day (1 - 31) |
|---|
|
| DayOfWeek | INT | Day of week (0 - 6) starting from Sunday. |
|---|
|
| Hour | INT | Hour (0 - 23) |
|---|
|
| MicroSecond | INT | A microsecond is one millionth of a second (0 - 999999) |
|---|
|
| MilliSecond | INT | A millisecond is one thousandth of a second (0 - 999) |
|---|
|
| Minute | INT | Minute (0 - 59) |
|---|
|
| Month | INT | Month (1 - 12) |
|---|
|
| Second | INT | Second (0 - 59) |
|---|
|
| SystemTime | BIGINT | Represents the system time when the time object was last queried. |
|---|
The SystemTime field returns the system time if the Time object has been queried. The time is represented in microseconds. This field serves no purpose beyond its initial query value.
|
|
| TimeStamp | BIGINT | Read this field to get representation of the time as a single integer. |
|---|
The TimeStamp field is a 64-bit integer that represents the time object as an approximation of the number of milliseconds represented in the time object (approximately the total amount of time passed since Zero-AD). This is convenient for summarising a time value for comparison with other time stamps, or for storing time in a 64-bit space.
The TimeStamp value is dynamically calculated when reading this field.
|
|
| Year | INT | Year (-ve for BC, +ve for AD). |
|---|
Actions
The following actions are currently supported:
| Name | Comment | | Query | Updates the values in a time object with the current system date and time. |
|---|
Methods
The following methods are currently supported:
| Name | Comment | | SetTime | Apply the time to the system clock. |
|---|
ERR pt::SetTime(OBJECTPTR Object)
This method will apply the time object's values to the BIOS. Depending on the host platform, this method may only work if the user is logged in as the administrator.
|