RtfwtcpipGetConfiguration

RtfwtcpipGetConfiguration returns the configuration of the TCP/IP Stack.

Syntax

Copy

bool RtfwtcpipGetConfiguration(
    [out] RTFW_TCPIP_CONFIGURATION * pConfiguration,
);

Parameters

[out] pConfiguration

A pointer to an RTFW_TCPIP_CONFIGURATION structure that is filled in with the current configuration of the TCP/IP Stack. The member Size must be set to sizeof(RTFW_TCPIP_CONFIGURATION), otherwise this API 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 does not fill in the structure pointed to by pConfiguration with valid 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