RtecatReadAxisTouchProbeStatus
RtecatReadAxisTouchProbeStatus reads the touch probe status of an axis.
Syntax
RTECAT_ERROR RtecatReadAxisTouchProbeStatus(
[in] RTECAT_HANDLE Axis,
[out] WORD* pValue
);Parameters
[in] Axis
A handle to an axis. To retrieve the corresponding handle, use RtecatOpenAxisByIndex or RtecatOpenAxisByLocation.
[out] pValue
A pointer to a variable that stores the touch probe status of an 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. |
|
ecatErrNullParameter |
Parameter pValue is NULL. |
|
ecatErrWrongParameter |
Parameter Axis is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice is not ready. |
|
ecatErrWrongEnvironment |
The link has not started. |
|
ecatErrVariableUnavailable |
The device does not support reading the touch probe status. |
Remarks
RtecatReadAxisTouchProbeStatus 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:
