RtfwStopSubsystem

RtfwStopSubsystem stops the RTX64 Subsystem and RT-TCP/IP Stack (if it is running).

Syntax

bool RtfwStopSubsystem(
);

Parameters

This function has no parameters.

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_SUBSYSTEM_NOT_STARTED	The RTX64 Subsystem is not started.
RT_ERROR_PROCESSES_RUNNING	The Subsystem cannot be stopped because there are real-time applications running or there are Windows applications running that have `RTAPI.DLL` loaded.
RT_ERROR_SUBSYSTEM_STARTSTOP_LOCK_FAILURE	Failed to obtain the lock to serialize starting/stopping the RTX64 Subsystem.
RT_ERROR_NETWORK_STOP_TIMEOUT	A timeout occurred waiting for the RT-TCP/IP Stack to stop.
RT_ERROR_RTSS_PROCESSES_RUNNING	The RTX64 Subsystem cannot be stopped, because one or more real-time processes are running.
RT_ERROR_PROXY_PROCESSES_RUNNING	The RTX64 Subsystem cannot be stopped, because one or more proxy processes are running.

Remarks

If there are real-time applications running or if there are Windows applications running that have RTAPI.DLL loaded (other than the one calling this API), this function fails and sets the last error value to RT_ERROR_PROCESS_RUNNING.

IMPORTANT! When this API is called, no other threads in the process can be executing a call to any function in RTAPI.DLL, otherwise they will malfunction.

Requirements

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