RtrlyGetComponentStatus
RtrlyGetComponentStatus returns the status of the Network Relay component.
Syntax
Copy
BOOL RtrlyGetComponentStatus(
[out] PRT_COMPONENT_STATUS Status
); Parameters
[out] Status
The current status of the Network Relay component from PRT_COMPONENT_STATUS.
Return Value
If the function succeeds, 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 current status of the Network Relay component in a reasonable amount of time. |
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtrlyComponent.h |
RtrlyApi.lib |
