Library.ReadSubDeviceAlias Method

Reads the alias address from a SubDevice.

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<ushort> ReadSubDeviceAlias(
    EcatHandle subDevice
)

Parameters

subDevice

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

Return Value

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

Possible errors:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	Parameter subDevice is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.