Library.GetModuleStatus Method

Gets the status of a module.

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 GetModuleStatus(
    EcatHandle module,
    ref ModuleStatus status
)

Parameters

module

Type: EcatHandle
A handle to a module. To retrieve the corresponding handle, use OpenModuleByIndex or OpenModuleByLocation.

status

Type: ModuleStatus
A reference to a ModuleStatus class that stores the module’s 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 module is invalid.

ecatErrMainDeviceNotReady

The MainDevice is not ready.

ecatErrWrongEnvironment

The MainDevice has not started.

See Also: