Library.CoeReadSdoODList Method

Reads the list of object indexes in a dictionary table through the CANopen over EtherCAT (CoE) SDO method.

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 CommandStatus<ushort[]> CoeReadSdoODList(
    EcatHandle subDevice,
    ushort listType,
    uint length
)

Parameters

subDevice

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

listType

Type: UInt16
An object index in the object dictionary.

length

Type: UInt32
The length, in bytes, of the buffer. The valid range is 1-512.

Return Value

This method returns a CommandStatus<ushort[]> class. The read result is stored in property Value. If an error occurs, property State in CommandStatus<ushort[]> is set to ecatCommandError, and the error code is stored in property ErrorId.

Possible errors:

Error code Meaning

ecatErrNoError

The function succeeded.

ecatErrWrongParameter

One of the following conditions occurred:

  • Parameter subDevice is invalid.
  • Parameter listType is less than 0 or greater than 5.
  • Parameter length is 0 or greater than 512.

ecatErrMainDeviceNotReady

The MainDevice is not ready.

ecatErrFeatureUnavailable

The SubDevice doesn't support CoE.

See Also: