Library.ConfigureAxis Method

Configures an axis. If the corresponding index contains a real axis module, the configuration set will be overridden.

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

Copy

public EcatErrorCode ConfigureAxis(
    EcatHandle mainDevice,
    uint index,
    SubDeviceStatus details,
    uint resolution
)

Parameters

mainDevice

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

index

Type: UInt32
The index of an axis.

details

Type: SubDeviceStatus
The configuration details to be applied to the axis.

resolution

Type: UInt32
The encoder resolution to be configured for the axis.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	One of the following conditions occurred: Parameter mainDevice is invalid. Parameter index exceeds the configured number of I/O modules. Parameter resolution is less than 0.
ecatErrMainDeviceNotReady	The MainDevice instance does not exist.
ecatErrWrongEnvironment	The MainDevice is not stopped. Calling this API after Library.Start is unsupported.