Library.GetStatus Method (Status, Diagnostics)

Gets the status and diagnostics information of a MainDevice.

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

Copy

public EcatErrorCode GetStatus(
    EcatHandle mainDevice,
    ref MainDeviceStatus status,
    ref MainDeviceDiagnostics diagnostics
)

Parameters

mainDevice

Type: EcatHandle
A handle to a MainDevice. To retrieve the corresponding handle, use CreateMainDevice or OpenMainDevice.

status

Type: MainDeviceStatus
A reference to a MainDeviceStatus class that stores the MainDevice status.

diagnostics

Type: MainDeviceDiagnostics
A reference to a MainDeviceDiagnostics class that stores the MainDevice diagnostics information.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter status or diagnostics is null.
ecatErrWrongParameter	Parameter mainDevice is invalid.
ecatErrMainDeviceNotReady	The MainDevice instance does not exist.