RtecatSetConfiguredAxisCount
RtecatSetConfiguredAxisCount sets the number of configured axes. If the actual number of detected real axes is less than the number configured, simulated axes will be generated during RtecatStart to match the configured number.
Syntax
RTECAT_ERROR RtecatSetConfiguredAxisCount(
[in] RTECAT_HANDLE MainDevice,
[in] ULONG Count
);Parameters
[in] MainDevice
A handle to a MainDevice. To retrieve the corresponding handle, use RtecatCreateMainDevice or RtecatOpenMainDevice.
[in] Count
The number of configured axes.
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 MainDevice or Count is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice instance does not exist. |
|
ecatErrWrongEnvironment |
The MainDevice is not stopped. Calling this API after RtecatStart is unsupported. |
Remarks
RtecatSetConfiguredAxisCount 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:
