RtecatWriteAxisTargetTorque

RtecatWriteAxisTargetTorque writes the target torque of an axis.

Syntax

Copy

RTECAT_ERROR RtecatWriteAxisTargetTorque(
  [in]    RTECAT_HANDLE Axis,
  [in]    short Value
);

Parameters

[in] Axis

A handle to an axis. To retrieve the corresponding handle, use RtecatOpenAxisByIndex or RtecatOpenAxisByLocation.

[in] Value

A short value to write that represents the target torque of an axis.

Return Values

The function returns an RTECAT_ERROR value. If the function succeeds, it returns ecatErrNoError. If the function fails, it returns a different value.

Possible return values:

Return value	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	Parameter Axis is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.
ecatErrVariableUnavailable	The device does not support writing the target torque.

Remarks

RtecatWriteAxisTargetTorque is a synchronous function that executes immediately and returns a result upon completion.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtecatApi.h	RtecatApi_W64.lib (Windows), RtecatApi.lib (RTSS)