RtecatForceAxisActualCurrent
RtecatForceAxisActualCurrent writes the actual current of a simulated axis.
Syntax
RTECAT_ERROR RtecatForceAxisActualCurrent(
[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 actual current of a simulated 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 axis is not a simulated one. |
Remarks
RtecatForceAxisActualCurrent 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) |
See Also:
