Library.GetSubDeviceStatus Method
Gets the status of a SubDevice.
Namespace:
IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly:
IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.1.0)
Syntax
public EcatErrorCode GetSubDeviceStatus(
EcatHandle subDevice,
ref SubDeviceStatus status
)
Parameters
subDevice
Type: EcatHandle
A handle to a SubDevice. To retrieve the corresponding handle, use OpenSubDeviceByIndex, OpenSubDeviceByStationAddress, or OpenSubDeviceByExplicitId.
status
Type: SubDeviceStatus
A reference to a SubDeviceStatus class that stores the SubDevice status.
Return Value
EcatErrorCode is thrown when any of these errors occur:
| Error code | Meaning |
|---|---|
|
ecatErrNoError |
The function succeeded. |
|
ecatErrNullParameter |
Parameter status is null. |
|
ecatErrWrongParameter |
Parameter subDevice is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice is not ready. |
|
ecatErrWrongEnvironment |
The MainDevice has not started. |
See Also: