RtecatGetAxisStatus

RtecatGetAxisStatus gets the status of an axis.

Syntax

Copy

RTECAT_ERROR RtecatGetAxisStatus(
  [in]    RTECAT_HANDLE Axis,
  [out]   RTECAT_AXIS_STATUS* pStatus
);

Parameters

[in] Axis

A handle to an axis. To retrieve the corresponding handle, use RtecatOpenAxisByIndex or RtecatOpenAxisByLocation.

[out] pStatus

A pointer to an RTECAT_AXIS_STATUS structure that receives detailed information about the axis’s status.

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 pStatus is NULL.
ecatErrWrongParameter	Parameter Axis is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

RtecatGetAxisStatus 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)