RtfwtcpipGetInterfaceSettings

RtfwtcpipGetInterfaceSettings returns a TCP/IP Stack interface configuration associated with a given name.

Syntax

Copy

bool RtfwtcpipGetInterfaceSettings(
    [in]   const TCHAR * Name,
    [out]  RTFW_TCPIP_INTERFACE * pTCPIPInterface
);

Parameters

[in] Name

A pointer to the name of an existing network interface. This value is not case sensitive.

[out] 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.

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 invalid 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