DosSetDateTime: Difference between revisions

Latest revision as of 18:21, 18 March 2019

DosSetDateTime sets the current date and time for the system. Although you can set day, month, year and weekday to whatever you want, DosSetDateTime will check if it is a correct combination and will return an error if it is incorrect.

Syntax

DosSetDateTime( pdt )

Parameters

PDATETIME pdt (input): The pointer to a DATETIME structure containing the date and time to be set as the system's date and time.

Returns

APIRET rc: 0 NO_ERROR; 327 ERROR_TS_DATETIME

Gotchas

The sign of the time zone is opposed to that ordinarily used. I.e. GMT+1 (Western Europe) <=> -60

Sample Code

#define INCL_DOSDATETIME
#include <os2.h>

DATETIME dt;

dt.hours=12;
dt.minutes=34;
dt.seconds=56;
dt.hundredths=78;
dt.day=8;
dt.month=7;
dt.year=1996;
dt.timezone=-60; /* West Europe */
dt.weekday=1;    /* Monday */

if(DosSetDateTime(&dt)) /* Set time to 12:34:56.78, Monday July 8, 1996 */
                        /* somewhere in Western Europe */
{
    /* Failure */
}
else
{
    /* Success */
}

Alternative Version

OS2Linux project (Common Public License) created a clone for this function [1].

@@ Line 1: / Line 1: @@
-==DosSetDateTime==
+'''DosSetDateTime''' sets the current date and time for the system. Although you can set day, month, year and weekday to whatever you want, DosSetDateTime will check if it is a correct combination and will return an error if it is incorrect.
 ===Syntax===
+ DosSetDateTime( ''pdt'' )
-rc = DosSetDateTime( ''pdt'' );
 ===Parameters===
+;PDATETIME ''pdt'' (input): The pointer to a [[DATETIME]] structure containing the date and time to be set as the system's date and time.
-; PDATETIME ''pdt'' (input)
-: The pointer to a DATETIME structure containing the date and time to be set as the system's date and time.
 ===Returns===
+;APIRET  rc
+:0   NO_ERROR
- APIRET  rc
+:327 ERROR_TS_DATETIME
-      NO_ERROR
-    ERROR_TS_DATETIME
-===Include Info===
- #define INCL_DOSDATETIME
- #include <os2.h>
-===Usage Explanation===
-DosSetDateTime sets the current date and time for the system. Although you can set day, month, year and weekday to whatever you want, DosSetDateTime will check if it is a correct combination and will return an error if it is incorrect.
-===Relevant Structures===
- typedef struct _DATETIME
- {
-   UCHAR  hours;       /* 0..23 */
-   UCHAR  minutes;     /* 0..59 */
-   UCHAR  seconds;     /* 0..59 */
-   UCHAR  hundredths;  /* 0..99, 1/100 s */
-   UCHAR  day;         /* 0..31 */
-   UCHAR  month;       /* 0..12 */
-   USHORT year;
-   SHORT  timezone;    /* Difference in minutes between current time zone and */
-                       /* GMT. > 0 west of Greenwich */
-   UCHAR  weekday;     /* 0..6 0=Sunday */
- } DATETIME, *PDATETIME;
 ===Gotchas===
+The sign of the time zone is opposed to that ordinarily used. I.e. GMT+1 (Western Europe) <=> -60
-The sign of the time zone is opposed to that ordinarily used. Ie GMT+1 (Western Europe) <=> -60
 ===Sample Code===
+<code>
   #define INCL_DOSDATETIME
   #include <os2.h>
@@ Line 65: / Line 33: @@
   if(DosSetDateTime(&dt)) /* Set time to 12:34:56.78, Monday July 8, 1996 */
-                        /* somewhere in western Europe */
+                         /* somewhere in Western Europe */
   {
       /* Failure */
@@ Line 73: / Line 41: @@
       /* Success */
   }
+</code>
 ===See Also===
-* [[OS2 API:DosGetDateTime|DosGetDateTime]]
+* [[DosGetDateTime]]
 ==Alternative Version==
 # OS2Linux project (Common Public License) created a clone for this function [https://github.com/OS2World/LINUX-SYSTEM-OS2Linux/blob/1eaffacb404b31b79068582ef8bf4d7583c8fa8d/os2/datetime.c].
+[[Category:Dos]]
-[[Category:The OS/2 API Project]]