RtfwGetTCPIPConfiguration

RtfwGetTCPIPConfiguration returns the configuration of the RT-TCP/IP Stack.

Syntax

bool RtfwGetTCPIPConfiguration(
    RTFW_TCPIP_CONFIGURATION * pConfiguration,
);

Parameters

pConfiguration

A pointer to a RTFW_TCPIP_CONFIGURATION structure that is filled in with the last set configuration of the RT-TCP/IP Stack. The member Size must be set to sizeof(RTFW_MONITOR_CONFIGURATION), otherwise this API fails and sets the last error value to RT_ERROR_STRUCTURE_TOO_SMALL.

Return Value

The function returns true if it succeeds. Otherwise, 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 for additional error information.

Possible error codes:

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

Remarks

If the RT-TCP/IP Stack is running when the RtfwSetTCPIPConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem when RtfwGetTCPIPConfiguration is called without restarting the Stack. Use RtfwGetTCPIPStatus to get the running Stack configuration.

If the Subsystem is running when the RtfwGetLocalMemoryConfiguration API is called, the values returned by this function may differ from the values currently in use by the Subsystem.

Requirements

Minimum Required Version	RTX64 4.0
Header	RtfwAPI.h
Library	RtfwAPI.lib