RtfwGetNALStatus

RtfwGetNALStatus returns the status of the Network Abstraction Layer (NAL).

Syntax

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

Parameters

pStatus

A pointer to an error code value that is set only if this API is successful. This error code applies to the Network Abstraction Layer (NAL) not to this API.

pErrorCode

A pointer to an error code.

Return Value

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

Possible last error values when this API fails:

Error Code Meaning
ERROR_INVALID_PARAMETER The value for the specified parameter is not valid.
RT_ERROR_TIMEOUT_QUERYING_NAL_STATUS A timeout occurred while querying the status of the NAL.

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

See Also:

RTFW_COMPONENT_STATUS

RtfwStartNAL

RtfwStartTCPIPStack

RtfwStopTCPIPStack

RtfwGetTCPIPStatus

RtfwGetNALClientProcessIDs

RtfwGetTCPIPClientProcessIDs

RtfwGetNetworkInterfacesStatus

RtfwGetSubsystemStatus

RtfwStopSubsystem