Library.ResetDiagnostics Method

Resets MainDevice and SubDevice diagnostics information.

Namespace: IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly: IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.1.0)

Syntax

Copy

public CommandStatus ResetDiagnostics(
    EcatHandle mainDevice,
    bool resetMainDevice,
    bool resetAllSubDevices
)

Parameters

mainDevice

Type: EcatHandle
A handle to a MainDevice. To retrieve the corresponding handle, use CreateMainDevice or OpenMainDevice.

resetMainDevice

Type: Boolean
true to reset MainDevice diagnostics information, false otherwise.

resetAllSubDevices

Type: Boolean
true to reset all SubDevices' diagnostics information, false otherwise.

Return Value

This method returns a CommandStatus class. If an error occurs, property State in CommandStatus is set to ecatCommandError, and the error code is stored in property ErrorId.

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	The MainDevice handle is invalid.
ecatErrMainDeviceNotReady	The MainDevice is not ready.