RtfwGetNetworkConfiguration

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

Syntax

bool RtfwGetNetworkConfiguration(
    RTFW_NETWORK_CONFIGURATION * pNetworkConfiguration,
    unsigned int reserved
);

Parameters

pNetworkConfiguration

A pointer to a RTFW_NETWORK_CONFIGURATION structure that is filled in with the current 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.

reserved

This parameter must always be zero.

Return Value

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the structure pointed to by pNetworkConfiguration with invalid member values. Call GetLastError for additional error information.

Possible error codes:

Error Code	Meaning
RT_ERROR_NETWORK_NOT_INSTALLED	The RT-TCP/IP Stack is not installed.
RT_ERROR_STRUCTURE_TOO_SMALL	The Size member of a structure is too small.

Remarks

If the Subsystem is running when the RtfwSetNetworkConfiguration 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 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib