Library.GetFeatureStatus Method

Gets the configuration of an E-CAT startup feature.

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 EcatErrorCode GetFeatureStatus(
    EcatHandle mainDevice,
    EcatFeature feature,
    ref double status
)

Parameters

mainDevice

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

feature

Type: EcatFeature
The E-CAT feature to be checked.

status

Type: Double
A reference to a variable that stores the status of feature.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrWrongParameter	One of the following conditions occurred: Parameter mainDevice is invalid. Parameter feature is invalid.
ecatErrMainDeviceNotReady	The MainDevice instance does not exist.
ecatErrFeatureUnavailable	Parameter feature is ecatFeatureDcReferenceIndex, which is not currently supported.