SetAxisTorque

Sets the target torque of an axis.

Syntax

KsError SetAxisTorque(
     int Index,
     double Torque
);

Parameters

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

Torque: the torque of an axis. The unit is percent (%). The minimum accepted value is 0.1.

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

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header ksmotion.h ksmotion.h
Library KsApi_Rtss.lib KsApi.lib

See also

GetAxisTorque

SetAxisPosition

SetAxisVelocity