Library.StartFromConfiguration Method

Starts a MainDevice using a configuration file created by the E-CAT Configuration Tool. Calling this method also requests the MainDevice to switch to the Op state.

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

Copy
public CommandStatus StartFromConfiguration(
    EcatHandle mainDevice,
    string configuration
)

Parameters

mainDevice

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

configuration

Type: String
The path of the configuration file.

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:

Error code Meaning

ecatErrNoError

The function succeeded.

ecatErrNullParameter

Parameter configuration is null.

ecatErrWrongParameter

Parameter mainDevice is invalid.

ecatErrMainDeviceNotReady

The MainDevice instance does not exist.

ecatErrWrongEnvironment

The MainDevice is not stopped.

See Also: