Library.RestartSubDevice Method

Restarts a SubDevice.

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

Syntax

public CommandStatus RestartSubDevice(
    EcatHandle subDevice
)

Parameters

subDevice

Type: EcatHandle
A handle to a SubDevice. To retrieve the corresponding handle, use OpenSubDeviceByIndex, OpenSubDeviceByStationAddress, or OpenSubDeviceByExplicitId.

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.

Possible errors:

Passing the returned command status to GetCommandStatus updates the command’s status. If an error occurs during the execution of the command in the system, GetCommandStatus will record the error in the returned command status. For more details, see EcatErrorCode.

See Also:

• Library Class
• IntervalZero.MaxRT.Ecat.Api.NetApi Namespace