RtfwtcpipSetInterfaceSettings

RtfwtcpipSetInterfaceSettings sets the configuration of a TCP/IP Stack interface.

Syntax

Copy

bool RtfwtcpipSetInterfaceSettings(
    [in]  const RTFW_TCPIP_INTERFACE * pTCPIPInterface,
    [in]  bool ignoreProtocolValidationResult,
    [out] bool * pProtocolsInvalid
);

Parameters

[in] pTCPIPInterface

A pointer to structure RTFW_TCPIP_INTERFACE that is filled with configuration information for the network interface. This value cannot be NULL, and member Size must be set to sizeof(RTFW_TCPIP_INTERFACE), otherwise this function fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

[in] ignoreProtocolValidationResult

If TRUE, this API will not fail when these changes invalidate another protocol's configuration settings on this interface. Otherwise, it will fail.

[out] pProtocolsInvalid

Set to TRUE if the configuration settings of another protocol are invalidated by this API. Otherwise, it will be set to false.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE, sets the last error value, and leaves the structure referenced by pTCPIPInterface with undefined member values. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
RT_ERROR_STRUCTURE_TOO_SMALL	The member Size of a structure is too small.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwtcpipApi.h	RtfwtcpipApi.lib