ClockGetDayOfWeek

This function calculates the day of the week 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
ClockGetDayOfWeek Date & Time Synchronous Supported Supported Supported Supported (see “Notes” below)

Syntax

  ClockGetDayOfWeek( numSeconds, optTimeZone )  
Web Studio Help  datetime clockgetdayofweek.xml d88970e85 ClockGetDayOfWeek

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 the day of the week as an integer:
Value Description
0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

If a time zone is specified, the day is adjusted to reflect the change from the current time zone to the specified time zone.

Notes

If this function is called on Mobile Access, it is executed using the system time on the project runtime server.

Examples

Get the day of the week when the system clock started counting (i.e., Wednesday):
  ClockGetTime(0)  
Get a returned value of 1 (Monday):
  ClockGetDayOfWeek(1018886359)  
Get the current number of seconds elapsed since 12:00 AM GMT on January 1, 1970, and then calculate the day of the week:
  ClockGetDayOfWeek(GetClock())  

ClockGetDayOfWeek