RtfwtcpipStartComponent starts the TCP/IP Stack component.
Syntax
BOOL RtfwtcpipStartComponent(); Parameters
This function has no parameters.
Return Value
If the function succeeds, and the component starts, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code if the function fails.
Possible error codes:
| Error code | Meaning |
|---|---|
|
RT_ERROR_NO_LICENSE |
The TCP/IP Stack component is not licensed. |
|
RT_ERROR_TCPIP_STARTED |
The TCP/IP component is running. |
|
RT_ERROR_TIMEOUT_STOPPING_NL2 |
Unable to start the NL2 component within a reasonable length of time. |
|
RT_ERROR_TIMEOUT_STOPPING_TCPIP |
Unable to start the TCP/IP component within a reasonable length of time. |
Remarks
The TCP/IP Stack component requires a Basic Network license (WNET64). Contact IntervalZero Sales to purchase licenses.
The TCP/IP component is dependent on the Network Link Layer (NL2). The NL2 must be started before the TCP/IP component can start. Calls to RtfwtcpipStartComponent will attempt to start the NL2 if it is not already started. This function will return FALSE if the NL2 cannot be started.
If RtfwtcpipStartComponent is called from a Windows application, the function will attempt to start the real-time Subsystem if it is not already started. RtfwtcpipStartComponent will return FALSE if the Subsystem cannot be started.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RttcpipComponent.h |
RtfwtcpipApi.lib (Windows), RttcpipApi.lib (RTSS) |
