GetAxisTorqueOffset

Gets the torque offset from an axis.

Syntax

KsError GetAxisTorqueOffset(
     int Index,
     double* Torque
);

Parameters

Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.

Torque: pointer to the value to receive the torque offset.

Return value

If the function succeeds, it returns errNoError, otherwise an error code. For more information about the error code, see the KsError list.

Remarks

This function can be used only when the TorqueOffset feature is enabled.

Example

Copy

double torOffset = 0.0;
KsError nRet = GetAxisTorqueOffset(0, &torOffset);

Requirements