RtecatGetModuleStatus

RtecatGetModuleStatus gets the status of a module.

Syntax

Copy

RTECAT_ERROR RtecatGetModuleStatus(
  [in]    RTECAT_HANDLE Module,
  [out]   RTECAT_MODULE_STATUS* pStatus
);

Parameters

[in] Module

A handle to a module. To retrieve the corresponding handle, use RtecatOpenModuleByIndex or RtecatOpenModuleByLocation.

[out] pStatus

A pointer to an RTECAT_MODULE_STATUS structure that stores the module’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 Module is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The link has not started.

Remarks

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