RtfwGetNetworkStatus

RtfwGetNetworkStatus returns the status of the RT-TCP/IP Stack.

Syntax

bool RtfwGetNetworkStatus(
    RTFW_SUBSYSTEM_STATUS * pStatus,
    unsigned int reserved
);

Parameters

pStatus

A pointer to a value that is set to an enumerator in RTFW_SUBSYSTEM_STATUS indicating the current status of the RT-TCP/IP Stack. This value will never be set to RTSS_NOT_CONFIGURED, because that status only applies to the RTX64 Subsystem.

reserved

This parameter must be set to zero.

Return Value

The function returns true if it succeeds. Otherwise, it returns false, sets the last error value, and leaves the memory pointed to by pStarted as invalid. 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.

Remarks

To start or stop the RT-TCP/IP stack, use functions RtfwStartNetwork and RtfwStopNetwork.

Requirements

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