Library.GetStatus Method (Diagnostics)

Gets the 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.0.1)

Syntax

Copy
public EcatErrorCode GetStatus(
    EcatHandle mainDevice,
    ref MainDeviceDiagnostics diagnostics
)

Parameters

mainDevice

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

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 diagnostics is null.

ecatErrWrongParameter

Parameter mainDevice is invalid.

ecatErrMainDeviceNotReady

The MainDevice instance does not exist.

See Also: