Terminates the execution of UNICENS.
This function stops further communication with the INIC, forces the INIC to protected mode and releases external resources, e.g. calls tx_complete_fptr
for previously transmitted application messages. After the termination is complete UNICENS will call stopped_fptr() and will no longer invoke the request_service_fptr.
The application shall no longer call any API function. Any previously retrieved UNICENS objects (e.g. messages) become invalid.
- Note
- Do not call this function within any of the UNICENS callbacks!
- Parameters
-
self | The instance |
stopped_fptr | Mandatory callback function which is invoked as soon as the termination has been completed. Possible result values are shown in the table below.
Result Code | Description |
UCS_RES_SUCCESS | Termination succeeded |
UCS_RES_ERR_TIMEOUT | The termination was forced after a definite time. A communication error or INIC reset may be the reason. |
|
- Returns
- Possible return values are shown in the table below.
Value | Description |
UCS_RET_SUCCESS | No error |
UCS_RET_ERR_PARAM | Mandatory callback function not provided |
UCS_RET_ERR_API_LOCKED | Initialization was not completed or termination has been started before |