Clk_GetDayOfWk()

Get the day of week.

Files

clk.h/clk.c

Prototype

CLK_DAY  Clk_GetDayOfWk (CLK_YR     yr,
                         CLK_MONTH  month,
                         CLK_DAY    day);

Arguments

yr

Year value [1900 to 2135].

month

Month value [1 to 12], (January to December).

day

Day value [1 to 31].

Returned Values

Day of week [1 to 7] (Sunday to Saturday), if no errors.

CLK_DAY_OF_WK_NONE, otherwise

Required Configuration

None.

Notes / Warnings

It’s only possible to get a day of week of an epoch supported by Clock:

• Earliest year is the NTP epoch start year, thus Year (yr) must be greater than or equal to CLK_NTP_EPOCH_YR_START.
• Latest year is the Clock epoch end year, thus Year (yr) must be less than CLK_EPOCH_YR_END.

Example Usage

CLK_DAY  day_of_wk;
 
day_of_wk = Clk_GetDayOfWk(2010, 9, 18);
printf("day of week = %u", day_of_wk);