RtfwtcpipStopComponent stops the TCP/IP Stack component.
Syntax
BOOL RtfwtcpipStopComponent(); Parameters
This function has no parameters.
Return Value
If the function succeeds, and the TCP/IP component stops, 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_TCPIP_CLIENTS_EXIST |
Client applications linked to the TCP/IP component are running. The TCP/IP component cannot be stopped until its client applications are stopped. |
|
RT_ERROR_TCPIP_STOPPED |
The TCP/IP component is not running. |
|
RT_ERROR_TIMEOUT_QUERYING_TCPIP_STATUS |
An issue has occurred while querying the status of the TCP/IP component. |
|
RT_ERROR_TIMEOUT_STOPPING_TCPIP |
An issue has occurred while attempting to stop the TCP/IP component. |
Remarks
The TCP/IP component cannot be stopped if client applications linked to it are running.
This function will not return until the TCP/IP Stack has stopped completely.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RttcpipComponent.h |
RtfwtcpipApi.lib (Windows), RttcpipApi.lib (RTSS) |
