Library.WriteSubDeviceRegister Method

Writes data into a SubDevice's register.

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 CommandStatus WriteSubDeviceRegister(
    EcatHandle subDevice,
    ushort offset,
    byte[] data
)

Parameters

subDevice

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

offset

Type: UInt16
The offset within the SubDevice's register to start writing.

data

Type: Byte[]
A buffer that contains the data to write into the SubDevice's register.

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:

Error code Meaning

ecatErrNoError

The function succeeded.

ecatErrNullParameter

Parameter data is null.

ecatErrWrongParameter

One of the following conditions occurred:

  • Parameter subDevice is invalid.
  • The length of parameter data is 0.

ecatErrMainDeviceNotReady

The MainDevice is not ready.

See Also: