Library.OpenAxisByIndex Method

Opens an axis by its index.

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 EcatErrorCode OpenAxisByIndex(
    EcatHandle mainDevice,
    ref EcatHandle axis,
    uint index
)

Parameters

mainDevice

Type: EcatHandle
A handle to a MainDevice. To retrieve the corresponding handle, use CreateMainDevice or OpenMainDevice.

axis

Type: EcatHandle
A reference to an axis handle.

index

Type: UInt32
The index of the axis.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter axis is null.
ecatErrWrongParameter	One of the following conditions occurred: Parameter mainDevice is invalid. Parameter index is out of range.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The MainDevice has not started.