Jump to main content

##

# TCPIP_SNTP_ConnectionParamSet Function

## C

    TCPIP_SNTP_RESULT TCPIP_SNTP_ConnectionParamSet(
        TCPIP_NET_HANDLE netH,
        IP_ADDRESS_TYPE ntpConnType,
        const char* ntpServer
    );

## Description

This function sets the parameters for the next SNTP connections.

## Preconditions

The TCP/IP Stack should have been inititialized.

## Parameters

Parameters | Description
--- | ---
netH | New interface to use as default SNTP interface. If 0, the current interface is not changed.
ntpConnType | Type of connection to make: IPv4 or IPv6. If IP_ADDRESS_TYPE_ANY, the current setting is not changed.
ntpServer | The NTP server to be used; name or IP address can be used. If NULL or empty, SNTP won't attempt any connection.

## Returns

- SNTP_RES_OK - If the call succeeded.
- TCPIP_SNTP_RESULT error code - If the call did not succeed.

## Remarks

None.