Library.CoeReadSdoObjectDescription Method

Reads the description of an object 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

public CommandStatus<SdoObjectDescription> CoeReadSdoObjectDescription(
    EcatHandle subDevice,
    ushort obIndex
)

Parameters

subDevice

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

obIndex

Type: UInt16
An object index in the object dictionary.

Return Value

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

Possible errors:

See Also:

• Library Class
• IntervalZero.MaxRT.Ecat.Api.NetApi Namespace