ReadAxisTouchProbeStatus

Reads the variable (#x60B9) of the state of touch probe.

Syntax

KsError ReadAxisTouchProbeStatus(
     int Index,
     WORD* Value
);

Parameters

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

Value: pointer to the buffer to receive the status of touch probe.

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

To use this function, touch probe must be enabled using EnableTouchProbe.

Usable EtherCAT states

ecatOP

Example

Copy

WORD tpStatus = 0;
nRet = ReadAxisTouchProbeStatus(0, &tpStatus);

Requirements