RtrlyStartComponent
RtrlyStartComponent starts the Network Relay component.
Syntax
BOOL RtrlyStartComponent(); 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 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_STARTED |
The Network Relay component is already started. |
Remarks
The Network Relay component is included in the wRTOS Runtime license. It does not require an additional license.
The Network Relay component will start the Network Link Layer (NL2) if it is not already running.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtrlyComponent.h |
RtrlyApi.lib |
