Library.SoeReadSsc Method

Reads data from a SubDevice through Servo Drive Profile over EtherCAT (SoE).

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<byte[]> SoeReadSsc(
    EcatHandle subDevice,
    byte driveNo,
    byte elementFlags,
    ushort idn,
    uint length
)

Parameters

subDevice

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

driveNo

Type: Byte
A drive's index.

elementFlags

Type: Byte
Which property of an idn is read.

idn

Type: UInt16
The identification number of an object.

length

Type: UInt32
The length, in bytes, of the buffer that stores the data to read. The valid range is 1-512.

Return Value

This method returns a CommandStatus<byte[]> class. The read result is stored in property Value. If an error occurs, property State in CommandStatus<byte[]> 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