6.1. Generic API return status values
Most of the functions and also some notifications will return an error status value to indicate whether a function was successfully executed or not. Some of the return status values have a generic meaning unspecific to the called API function.
The function was successfully executed |
|
Unsupported feature or functionality |
|
The MainDevice is currently busy and the function has to be re-tried at a later time |
|
Not enough memory or frame buffer resources available |
|
Invalid or inconsistent parameters |
|
Timeout error |
|
A SubDevice error was detected |
The SubDevice is not in the requested state to execute the operation (e.g. when initiating a mailbox transfer the SubDevice must be at least in PREOP state) |
|
The SubDevice does not respond to its station address (e.g. when requesting its AL_STATUS value). The SubDevice may be removed from the bus or powered-off. |
|
Link cable not connected |
|
MainDevice core inaccessible. This result code usually means a remote connected server / EtherCAT® MainDevice does not respond anymore. |
The EC_E_BUSY return status value indicates that a previously requested operation is still in progress. For example if the MainDevice is requested to enter the OPERATIONAL state the next request from the API will return this status value unless the OPERATIONAL state is entered.