RtfwStopNAL

RtfwStopNAL stops the Network Abstraction Layer (NAL).

Syntax

bool RtfwStopNAL(
    unsigned int timeout
);

Parameters

timeout

Specifies the amount of time (in seconds) this function will wait for the NAL to stop. If this value is zero, an appropriate timeout is computed dynamically based on the number of enabled NAL and TCP/IP Stack interfaces.

Return Value

The function returns true if it succeeds. Otherwise, it returns false. Call GetLastError for additional error information.

Possible error codes:

Error Code	Meaning
RT_ERROR_NETWORK_NOT_STARTED	The NAL is already stopped.
RT_ERROR_NETWORK_CLIENTS_EXIST	The NAL cannot be stopped, because one or more TCPIP Stack or NAL client processes are still running.
RT_ERROR_NETWORK_STOP_TIMEOUT	A timeout occurred waiting for the NAL to stop.
RT_ERROR_NETWORK_STARTSTOP_LOCK_FAILURE	Failed to obtain the lock to serialize starting/stopping the RTX64 Subsystem.

Remarks

If the NAL does not stop within the specified timeout period, this function fails and sets the last error value to RT_ERROR_NETWORK_STOP_TIMEOUT.

Requirements

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