SetAxisTorqueOffset
Sets a torque offset of an axis.
Syntax
KsError SetAxisTorqueOffset(
int Index,
double Torque
);
Parameters
Index: the index of an axis. Indexes are zero based. Aliases affect this parameter.
Torque: the torque offset of an axis in 0.1 percent unit.
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
- Sets an axis' torque while using the torque control mode.
- This function can be used only if the TorqueOffset feature is enabled.
Example
Copy
KsError nRet = SetAxisTorqueOffset(0, 1.5);
Requirements
| RT | Win32 | |
|---|---|---|
| Minimum supported version | 4.0 | 4.0 |
| Header | ksmotion.h | ksmotion.h |
| Library | KsApi_Rtss.lib | KsApi.lib |
See also