en:docs:fapi:dosgetdatetime

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
en:docs:fapi:dosgetdatetime [2018/08/31 07:28] – created prokusheven:docs:fapi:dosgetdatetime [2021/12/05 09:57] (current) – prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== DosGetDateTime ======
  
 This call gets the current date and time maintained by the operating system.  This call gets the current date and time maintained by the operating system. 
  
-==Syntax== +===== Syntax =====
- DosGetDateTime (DateTime)+
  
-==Parameters== +<code c> 
-;DateTime (PDATETIME) - output : Address of the date and time structure: +DosGetDateTime (DateTime) 
-::hours (UCHAR) - Current hour +</code> 
-::minutes (UCHAR) - Current minute + 
-::seconds (UCHAR) - Current second +===== Parameters ===== 
-::hundredths (UCHAR) - Current hundredth of a second + 
-::day (UCHAR) - Current day +  * DateTime ([[PDATETIME]]) - output : Address of the date and time structure: 
-::month (UCHAR) - Current month +    * hours ([[UCHAR]]) - Current hour 
-::year (USHORT) - Current year +    * minutes ([[UCHAR]]) - Current minute 
-::timezone (SHORT) - Minutes west of UTC (Universal Time Coordinate) +    * seconds ([[UCHAR]]) - Current second 
-::weekday (UCHAR) - Current day of the week. Sunday is 0.+    * hundredths ([[UCHAR]]) - Current hundredth of a second 
 +    * day ([[UCHAR]]) - Current day 
 +    * month ([[UCHAR]]) - Current month 
 +    * year ([[USHORT]]) - Current year 
 +    * timezone ([[SHORT]]) - Minutes west of UTC (Universal Time Coordinate) 
 +    * weekday ([[UCHAR]]) - Current day of the week. Sunday is 0. 
 + 
 +===== Return Code ===== 
 + 
 +rc ([[USHORT]]) - return
  
-==Return Code== 
- rc (USHORT) - return 
 Return code description is: Return code description is:
-* 0  NO_ERROR 
  
-==Remarks== +  * 0  NO_ERROR
-The dayofweek value is based on Sunday equal to zero. The value of timezone is the difference in minutes between the current time zone and UTC. This number is positive if it is earlier than UTC and negative if it is later than UTC. For Eastern Standard Time, this value is 300 (5 hours earlier than UTC).+
  
-If the application is executing in the OS/2 environment, it is more efficient to obtain these variables by calling DosGetInfoSeg instead of this function. However, applications written to the family API cannot depend on the availability of DosGetInfoSeg. +===== Remarks =====
  
-==Example Code== +The dayofweek value is based on Sunday equal to zero. The value of timezone is the difference in minutes between the current time zone and UTC. This number is positive if it is earlier than UTC and negative if it is later than UTC. For Eastern Standard Time, this value is 300 (5 hours earlier than UTC).
-===C Binding=== +
-<PRE> +
-typedef struct _DATETIME {  /* date */ +
-  UCHAR   hours;            /* current hour */ +
-  UCHAR   minutes;          /* current minute */ +
-  UCHAR   seconds;          /* current second */ +
-  UCHAR   hundredths;       /* current hundredths of a second */ +
-  UCHAR   day;              /* current day */ +
-  UCHAR   month;            /* current month */ +
-  USHORT  year;             /* current year */ +
-  SHORT   timezone;         /* minutes of time west of UTC */ +
-  UCHAR   weekday;          /* current day of week */  +
-} DATETIME;+
  
-#define INCL_DOSDATETIME+If the application is executing in the OS/2 environment, it is more efficient to obtain these variables by calling [[DosGetInfoSeg]] instead of this function. However, applications written to the family API cannot depend on the availability of DosGetInfoSeg. 
  
-USHORT    rc = DosGetDateTime(DateTime); +===== Example Code =====
-PDATETIME DateTime;      /* Address of date/time structure (returned) */ +
-USHORT    rc;            /* return code */ +
-</PRE> +
-This example gets the current time and date. +
-<PRE> +
-#define INCL_DOSDATETIME+
  
-DATETIME DateBuffer; +==== C Binding ====
-USHORT   rc;+
  
-rc = DosGetDateTime(&DateBuffer);        /* Date/Time structure */ +<code c> 
-</PRE> +  typedef struct _DATETIME {  /* date */ 
-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.+    UCHAR   hours;            /* current hour */ 
 +    UCHAR   minutes;          /* current minute */ 
 +    UCHAR   seconds;          /* current second */ 
 +    UCHAR   hundredths;       /* current hundredths of a second */ 
 +    UCHAR   day;              /* current day */ 
 +    UCHAR   month;            /* current month */ 
 +    USHORT  year;             /* current year */ 
 +    SHORT   timezone;         /* minutes of time west of UTC */ 
 +    UCHAR   weekday;          /* current day of week */  
 +  } DATETIME; 
 +   
 +  #define INCL_DOSDATETIME 
 +   
 +  USHORT    rc = DosGetDateTime(DateTime); 
 +  PDATETIME DateTime;      /* Address of date/time structure (returned) */ 
 +  USHORT    rc;            /* return code */
  
-<PRE> +</code>
-#define INCL_DOSDATETIME +
-#include <os2.h>+
  
-main() +This example gets the current time and date.
-{ +
-  DATETIME   DateTime;       /* Structure to hold date/time info. */ +
-  USHORT     rc;+
  
-  rc = DosGetDateTime(&DateTime);     /* Address of d/t structure */ +<code c> 
-  printf("Today is %d-%d-%d; the time is %d:%d\n", DateTime.month, +  #define INCL_DOSDATETIME 
-         DateTime.day, DateTime.year, DateTime.hours, DateTime.minutes); +   
-  DateTime.day = 10; +  DATETIME DateBuffer; 
-  DateTime.month = 5; +  USHORT   rc; 
-  DateTime.year = 1987; +   
-  printf("The new date is %d-%d-%d; the time is %d:%d\n", DateTime.month, +  rc = DosGetDateTime(&DateBuffer);        /* Date/Time structure */ 
-         DateTime.day, DateTime.year, DateTime.hours, DateTime.minutes); +</code> 
-  rc = DosSetDateTime(&DateTime);    /* Address of d/t structure */ + 
-  printf("rc is %d\n", rc); +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>+
  
-===MASM Binding=== +<code c> 
-<PRE> +  #define INCL_DOSDATETIME 
-DATETIME struc +  #include <os2.h> 
-  date_hours      db  ? ;current hour +   
-  date_minutes    db  ? ;current minute +  main() 
-  date_seconds    db  ? ;current second +  { 
-  date_hundredths db  ? ;current hundredths of a second +    DATETIME   DateTime;       /* Structure to hold date/time info. */ 
-  date_day        db  ? ;current day +    USHORT     rc; 
-  date_month      db  ? ;current month +   
-  date_year       dw  ? ;current year +    rc = DosGetDateTime(&DateTime);     /* Address of d/t structure */ 
-  date_timezone   dw  ? ;minutes of time west of UTC +    printf("Today is %d-%d-%d; the time is %d:%d\n", DateTime.month, 
-  date_weekday    db  ? ;current day of week +           DateTime.day, DateTime.year, DateTime.hours, DateTime.minutes); 
-DATETIME ends+    DateTime.day = 10; 
 +    DateTime.month = 5; 
 +    DateTime.year = 1987; 
 +    printf("The new date is %d-%d-%d; the time is %d:%d\n", DateTime.month, 
 +           DateTime.day, DateTime.year, DateTime.hours, DateTime.minutes); 
 +    rc = DosSetDateTime(&DateTime);    /* Address of d/t structure */ 
 +    printf("rc is %d\n", rc); 
 +   } 
 +</code>
  
-EXTRN  DosGetDateTime:FAR +==== MASM Binding ====
-INCL_DOSDATETIME    EQU 1+
  
-PUSH@  OTHER   DateTime      ;Date/time structure (returned) +<code asm> 
-CALL   DosGetDateTime+  DATETIME struc 
 +    date_hours      db  ? ;current hour 
 +    date_minutes    db  ? ;current minute 
 +    date_seconds    db  ? ;current second 
 +    date_hundredths db  ? ;current hundredths of a second 
 +    date_day        db  ? ;current day 
 +    date_month      db  ? ;current month 
 +    date_year       dw  ? ;current year 
 +    date_timezone   dw  ? ;minutes of time west of UTC 
 +    date_weekday    db  ? ;current day of week 
 +  DATETIME ends 
 +   
 +  EXTRN  DosGetDateTime:FAR 
 +  INCL_DOSDATETIME    EQU 1 
 +   
 +  PUSH@  OTHER   DateTime      ;Date/time structure (returned) 
 +  CALL   DosGetDateTime 
 +</code>
  
 Returns WORD Returns WORD
-</PRE> 
  
-====== Note ======+===== Note =====
  
 Text based on [[http://www.edm2.com/index.php/DosGetDateTime_(Legacy)]] Text based on [[http://www.edm2.com/index.php/DosGetDateTime_(Legacy)]]