RtfwStartSubsystem

RtfwStartSubsystem starts the RTX64 Subsystem.

Syntax

bool RtfwStartSubsystem(
);

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_NO_STACK_LICENSE There is no license for the RT-TCP/IP Stack, but the Stack was configured to automatically start with the RTX64 Subsystem.
RT_ERROR_TIMEOUT_STARTING_SUBSYSTEM Timeout waiting for the Subsystem to start.
RT_ERROR_TIMEOUT_STARTING_NETWORK Timeout waiting for the RT-TCP/IP stack to start.
RT_ERROR_SUBSYSTEM_STARTSTOP_LOCK_FAILURE Failed to obtain the lock to serialize starting/stopping the RTX64 Subsystem.
RT_ERROR_SUBSYSTEM_NOT_STOPPED The RTX64 Subsystem cannot be started because it is not in the stopped state.
RT_ERROR_SUBSYSTEM_NOT_CONFIGURED The RTX64 Subsystem is not configured, but an operation was attempted that requires it to be configured.

Remarks

If the Subsystem has not been configured yet, this function fails and sets the last error value to RT_ERROR_SUBSYSTEM_NOT_CONFIGURED.

After this function succeeds, the Subsystem is started. If the RT-TCP/IP Stack is configured to start automatically when the Subsystem starts, then it is also started.

Requirements

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

See Also:

RTFW_COMPONENT_STATUS

RtfwGetSubsystemStatus

RtfwStopSubsystem

RtfwStartTCPIPStack

RtfwStopTCPIPStack