Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Converts a date/time structure to an ASCII string.

Files

clk.h/clk.c

Prototype

Arguments

p_date_time

Pointer to variable that contains the date/time structure to convert.

...

Maximum number of characters the string can contains.

Returned Values

DEF_OK, if string successfully returned.

DEF_FAIL, otherwise.

Required Configuration

Available only if CLK_CFG_STR_CONV_EN is DEF_ENABLED in clk_cfg.h (see section 3-1-1).

Notes / Warnings

It’s only possible to convert date supported by Clock:

...

The size of the string buffer that will receive the returned string address must be greater than or equal to CLK_STR_FMT_MAX_LEN.

Example Usage