Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Clk_DateTimeMake()

Build a valid Clock epoch date/time structure.

Files

clk.h/clk.c

Prototype

Arguments

p_date_time

Pointer to variable that will receive the date/time structure.

yr

Year value [CLK_EPOCH_YR_START to CLK_EPOCH_YR_END).

month

Month value [CLK_MONTH_JAN to CLK_MONTH_DEC].

day

Day value [1 to 31].

hr

Hours value [0 to 23].

min

Minutes value [0 to 59].

sec

Seconds value [0 to 60].

tz_sec

Time zone offset (in seconds, ± from UTC) [-43200 to 43200].

Returned Values

DEF_OK

, if date/time structure successfully returned.

DEF_FAIL

, otherwise.

Required Configuration

None.

Notes / Warnings

Date/time structure (p_date_time) must be representable in Clock timestamp. Thus date to convert must be greater than or equal to CLK_EPOCH_YR_START and less than CLK_EPOCH_YR_END.

Example Usage

  • No labels