Versions Compared

Key

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

Initializes the SNTPc module.

Files

sntp-c.h/sntp-c.c

Prototype

Code Block
languagemicrium
CPU_BOOLEAN  SNTPc_Init (const  SNTPc_CFG       *p_cfg,
                                SNTPc_ERR       *p_err);

Arguments

p_cfg

Pointer to the run-time configuration. See Run-time Configuration for further information.

p_err            

Pointer to variable that will receive the return error code from this function.

Returned Values

DEF_OK,     if initialization was successful.
DEF_FAIL, otherwise.

Required Configuration

Run-time Configuration

Notes / Warnings

This function must be called prior to using other SNTP client functions.

Example Usage

See Sample Application.