1.2.15.5 WDRV_WINC_SystemTimeSNTPClientEnable Function
C
WDRV_WINC_STATUS WDRV_WINC_SystemTimeSNTPClientEnable ( DRV_HANDLE handle, const char *pServerName, bool allowDHCPOverride );
Summary
Enable the SNTP client to set system time.
Description
Enables the SNTP client used to set the system time.
Precondition
WDRV_WINC_Initialize should have been called. WDRV_WINC_Open should have been called to obtain a valid handle.
Parameters
| Param | Description |
|---|---|
| handle | Client handle obtained by a call to WDRV_WINC_Open. |
| pServerName | Pointer to the NTP server name |
| allowDHCPOverride | Flag indicating if the DHCP setting for NTP server should override the system server name. |
Returns
WDRV_WINC_STATUS_OK - The request has been accepted.
WDRV_WINC_STATUS_NOT_OPEN - The driver instance is not open.
WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.
WDRV_WINC_STATUS_REQUEST_ERROR - The request to the WINC was rejected.
Remarks
pServerName may be NULL to indicate no specified NTP server name will be used. If allowDHCPOverride is also true then the server name can still be set via DHCP. If the first character is an asterisk (*) then it will be treated as a server pool, where the asterisk will be replaced with an incrementing value from 0 to 3 each time a server fails (example: *.pool.ntp.org) Configurable server name and DHCP override control at not available on WINC3400 and WINC1500 pre 19.6.0.