RtrlyStopComponent
RtrlyStopComponent stops the Network Relay component.
Syntax
Copy
BOOL RtrlyStopComponent(); Parameters
This function has no parameters.
Return Value
If the function succeeds, and the 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 |
|---|---|
|
RTRLY_ERROR_STOPPED |
The Network Relay component is not running. |
|
RT_ERROR_NO_LICENSE |
The Network Relay component does not have a valid license. |
|
RTRLY_ERROR_TIMEOUT_QUERYING_STATUS |
Unable to determine the status of the Network Relay component within a reasonable amount of time. |
|
RTRLY_ERROR_TIMEOUT_STOPPING |
Unable to stop the Network Relay component within a reasonable amount of time. |
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtrlyComponent.h |
RtrlyApi.lib |
