Library.OpenModuleByLocation Method

Opens a module by its location.

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 OpenModuleByLocation(
    EcatHandle subDevice,
    ref EcatHandle module,
    int slotId
)

Parameters

subDevice

Type: EcatHandle
A handle to a SubDevice. To retrieve the corresponding handle, use OpenSubDeviceByIndex, OpenSubDeviceByStationAddress, or OpenSubDeviceByExplicitId.

module

Type: EcatHandle
A reference to a module handle.

slotId

Type: Int32
The index of the slot.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter module is null.
ecatErrWrongParameter	One of the following conditions occurred: Parameter subDevice is invalid. Parameter slotId is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The MainDevice has not started.