RtecatGetFeatureStatus
RtecatGetFeatureStatus gets the configuration of an EtherCAT startup feature.
Syntax
RTECAT_ERROR RtecatGetFeatureStatus(
[in] RTECAT_HANDLE MainDevice,
[in] RTECAT_FEATURE Feature,
[out] double* pStatus
);Parameters
[in] MainDevice
A handle to a MainDevice. To retrieve the corresponding handle, use RtecatOpenMainDevice.
[in] Feature
An EtherCAT feature. See RTECAT_FEATURE.
[out] pStatus
A pointer to a variable that stores the status of Feature.
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. |
|
ecatErrNullParameter |
Parameter pStatus is NULL. |
|
ecatErrWrongParameter |
Parameter MainDevice or Feature is invalid. |
|
ecatErrMainDeviceNotReady |
The MainDevice instance does not exist. |
|
ecatErrFeatureUnavailable |
Parameter Feature is ecatFeatureDcReferenceIndex, which is not currently supported. |
Remarks
RtecatGetFeatureStatus 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) |
See Also:
