Library.WriteAxisMaxCurrent Method

Writes the maximum current of an axis.

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 WriteAxisMaxCurrent(
    EcatHandle axis,
    short value
)

Parameters

axis

Type: EcatHandle
A handle to an axis. To retrieve the corresponding handle, use OpenAxisByIndex or OpenAxisByLocation.

value

Type: Int16
A value to write that represents the maximum current of an axis.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	Parameter axis is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The MainDevice has not started.
ecatErrVariableUnavailable	The device does not support writing the maximum current.