Library.VoeWrite Method

Writes data to a VoE-enabled device through Vendor-Specific Protocol over EtherCAT (VoE).

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 VoeWrite(
    EcatHandle subDevice,
    uint vendorId,
    ushort vendorType,
    byte[] data
)

Parameters

subDevice

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

vendorId

Type: UInt32
A vendor ID.

vendorType

Type: UInt16
A vendor type.

data

Type: Byte[]
A buffer that contains the data to write to the VoE-enabled device.

Return Value

This method returns a CommandStatus class. If an error occurs, property State in CommandStatus 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