RtecatGetStatus

RtecatGetStatus gets the status of a MainDevice.

Syntax

Copy

RTECAT_ERROR RtecatGetStatus(
  [in]    RTECAT_HANDLE MainDevice,
  [out]   RTECAT_MAINDEVICE_STATUS* pStatus,
  [out]   RTECAT_MAINDEVICE_DIAGNOSTICS* pDiagnostics
);

Parameters

[in] MainDevice

A handle to a MainDevice. To retrieve the corresponding handle, use RtecatOpenMainDevice.

[out] pStatus

A pointer to an RTECAT_MAINDEVICE_STATUS structure that stores the status of the MainDevice.

[out] pDiagnostics

A pointer to an RTECAT_MAINDEVICE_DIAGNOSTICS structure that stores the diagnostic information of the MainDevice.

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	Both parameter pStatus and pDiagnostics are NULL.
ecatErrWrongParameter	Parameter MainDevice is invalid.
ecatErrMainDeviceNotReady	The MainDevice instance does not exist.

Remarks

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