RtfwGetTCPIPStatus

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

Syntax

bool RtfwGetTCPIPStatus(
    RTFW_COMPONENT_STATUS * pStatus,
    DWORD * pErrorCode
);

Parameters

pStatus

A pointer to structure RTFW_COMPONENT_STATUS that returns the current status of the TCP-IP Stack.

pErrorCode

A pointer to an error code value.

Return Value

The function returns true if it succeeds. Otherwise, it returns false.

Possible error codes:

Error Code	Meaning
ERROR_INVALID_PARAMETER	The specified parameter value is not valid.
RT_ERROR_TIMEOUT_QUERYING_TCPIP_STATUS	A timeout occurred while querying for the status of the RT-TCP/IP Stack.

Remarks

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