RtecatResetDiagnostics

RtecatResetDiagnostics resets MainDevice and SubDevice diagnostics information.

Syntax

Copy

RTECAT_ERROR RtecatResetDiagnostics(
  [in]    RTECAT_HANDLE MainDevice,
  [in]    BOOL ResetMainDevice,
  [in]    BOOL ResetAllSubDevices
);

Parameters

[in] MainDevice

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

[in] ResetMainDevice

TRUE to reset MainDevice diagnostics information, FALSE otherwise.

[in] ResetAllSubDevices

TRUE to reset all SubDevices' diagnostics information, FALSE otherwise.

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.
ecatErrWrongParameter	The MainDevice handle is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.

Remarks

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