Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Last revisionBoth sides next revision | ||
en:docs:fapi:dossetdatetime [2021/08/20 04:22] – prokushev | en:docs:fapi:dossetdatetime [2021/09/17 08:24] – prokushev | ||
---|---|---|---|
Line 5: | Line 5: | ||
This call is used to set the date and time that are maintained by the operating system. | This call is used to set the date and time that are maintained by the operating system. | ||
- | ==Syntax== | + | ===== Syntax ===== |
- | | + | |
- | ==Parameters== | + | <code c> |
- | ;DateTime (PDATETIME) - input : Address of the date and time structure: | + | DosSetDateTime (DateTime) |
- | ::hours (UCHAR) - Current hour (0-23) | + | </ |
- | ::minutes (UCHAR) - Current minute (0-59) | + | |
- | ::seconds (UCHAR) - Current second (0-59) | + | ===== Parameters |
- | ::hundredths (UCHAR) - Current hundredth of a second (0-99) | + | |
- | ::day (UCHAR) - Current day (1-31) | + | * DateTime ([[PDATETIME]]) - input : Address of the date and time structure: |
- | ::month (UCHAR) - Current month (1-12) | + | |
- | ::year (USHORT) - Current year (1980-2079) | + | |
- | ::timezone (SHORT) - Minutes west of UTC (Universal Time Coordinate -720 to 720). | + | |
- | ::weekday (UCHAR) - Current day of the week. This value is ignored and is calculated from the other parameter information. | + | |
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | ===== Return Code ===== | ||
+ | |||
+ | rc ([[USHORT]]) - return | ||
- | ==Return Code== | ||
- | rc (USHORT) - return | ||
Return code descriptions are: | Return code descriptions are: | ||
- | * 0 NO_ERROR | ||
- | *327 ERROR_TS_DATETIME | ||
- | ==Remarks== | + | * 0 NO_ERROR |
+ | *327 ERROR_TS_DATETIME | ||
+ | |||
+ | ===== Remarks ===== | ||
The value of timezone is the difference in minutes between the current time zone and UTC. This is a positive number if earlier than UTC, and negative number if it is later. For Eastern Standard Time this value is 300 (five hours earlier than UTC). | The value of timezone is the difference in minutes between the current time zone and UTC. This is a positive number if earlier than UTC, and negative number if it is later. For Eastern Standard Time this value is 300 (five hours earlier than UTC). | ||
- | To get the date and time, issue DosGetDateTime. If the application is executing in the OS/2 environment, | + | To get the date and time, issue [[DosGetDateTime]]. If the application is executing in the OS/2 environment, |
Not adhering to the limits on any of the parameters results in the return code being set to rc = 327 (ERROR_TS_DATETIME). Also, OS/2 verifies that the day is possible for the month and the year (even for leap year). If the day is not reasonable, OS/2 will also set rc = 327. | Not adhering to the limits on any of the parameters results in the return code being set to rc = 327 (ERROR_TS_DATETIME). Also, OS/2 verifies that the day is possible for the month and the year (even for leap year). If the day is not reasonable, OS/2 will also set rc = 327. | ||
- | ==Example Code== | + | ===== Example Code ===== |
- | ===C Binding=== | + | |
- | <PRE> | + | ==== C Binding ==== |
+ | |||
+ | <code c> | ||
typedef struct _DATETIME { /* date */ | typedef struct _DATETIME { /* date */ | ||
UCHAR | UCHAR | ||
Line 53: | Line 63: | ||
PDATETIME DateTime; | PDATETIME DateTime; | ||
USHORT | USHORT | ||
- | </PRE> | + | </code> |
The following example obtains and prints date and time information. It then changes the system date to 5/10/1987 and prints the updated information. | The following example obtains and prints date and time information. It then changes the system date to 5/10/1987 and prints the updated information. | ||
- | <PRE> | + | |
+ | <code c> | ||
#define INCL_DOSDATETIME | #define INCL_DOSDATETIME | ||
#include < | #include < | ||
Line 75: | Line 87: | ||
printf(" | printf(" | ||
} | } | ||
- | </PRE> | + | </code> |
- | ===MASM Binding=== | + | ==== MASM Binding ==== |
- | <pre> | + | |
+ | <code c> | ||
DATETIME struc | DATETIME struc | ||
date_hours | date_hours | ||
Line 96: | Line 109: | ||
PUSH@ OTHER | PUSH@ OTHER | ||
CALL | CALL | ||
+ | </ | ||
Returns WORD | Returns WORD | ||
- | </ | ||
- | |||
- | |||
- | ====== Note ====== | + | ===== Note ===== |
Text based on [[http:// | Text based on [[http:// |