RtecatGetSubDeviceStatus
RtecatGetSubDeviceStatus gets the status of a SubDevice.
Syntax
RTECAT_ERROR RtecatGetSubDeviceStatus(
[in] RTECAT_HANDLE SubDevice,
[out] RTECAT_SUBDEVICE_STATUS* pStatus
);Parameters
[in] SubDevice
A handle to a SubDevice. To retrieve the corresponding handle, use RtecatOpenSubDeviceByIndex, RtecatOpenSubDeviceByStationAddress, or RtecatOpenSubDeviceByExplicitId.
[out] pStatus
A pointer to an RTECAT_SUBDEVICE_STATUS structure that stores the SubDevice’s status.
Return Values
The function returns an RTECAT_ERROR value. If the function succeeds, it returns ecatErrNoError. If the function fails, it returns a different value.
Possible return values:
| Return value | Meaning |
|---|---|
|
ecatErrNoError |
The function succeeded. |
|
ecatErrNullParameter |
Parameter pStatus is NULL. |
|
ecatErrWrongParameter |
Parameter SubDevice is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice is not ready. |
|
ecatErrWrongEnvironment |
The link has not started. |
Remarks
RtecatGetSubDeviceStatus is a synchronous function that executes immediately and returns a result upon completion.
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtecatApi.h |
RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS) |
See Also:
