ClockGetDate
This function calculates the date that corresponds to a specified number of seconds that have elapsed since 12:00 AM GMT on January 1, 1970.
Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
---|---|---|---|---|---|---|
ClockGetDate | Date & Time | Synchronous | Supported | Supported | Supported | Supported (see “Notes” below) |
Syntax
ClockGetDate( numSeconds, optTimeZone )
- numSeconds
- A number of seconds that have elapsed since 12:00 AM GMT on January 1, 1970. This number is typically provided by the function GetClock, but it can be any number.
- optTimeZone
- A time zone name (string) or index (integer).
Value Description -i A time zone index (i), up to the maximum index returned by the function GetTimeZoneCount. On Windows Embedded Compact, the only valid index is -1 (i.e., the current time zone).
0 The current time zone in either the project runtime or the Viewer module / thin client, depending on where the function is called from. This may be different from the current time zone in the local computer’s system settings, if the function SetTimeZone was executed previously.
1 Coordinated Universal Time (UTC). 2 The current time zone in the local computer’s system settings. On Windows Embedded Compact, this value is invalid.
"timezone" The full name of a time zone (e.g., "Central Standard Time"). On Windows Embedded Compact, this value is invalid.
This parameter is optional; if you do not specify a tag or value, then the default value is 0.
Returned value
If this function is executed successfully, it returns a string that contains the date that corresponds to the specified number of seconds. If a time zone is specified, the date is adjusted to reflect the change from the current time zone to the specified time zone. The date is formatted as MM/DD/YYYY.
If this function is not executed successfully — for example, if the specified time zone is invalid — it returns a value of 0.
Notes
If this function is called on Mobile Access, it is executed using the system time on the project runtime server.
Examples
ClockGetDate(0,"Greenwich Mean Time")
ClockGetDate(1018886359)
ClockGetDate(GetClock(),"Central Standard Time")