From d2e42029ec04c3f224580f8007cdfbbfe0fc47a6 Mon Sep 17 00:00:00 2001 From: Fulup Ar Foll Date: Fri, 26 May 2017 18:45:56 +0200 Subject: Initial Commit --- ...__s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html | 168 +++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html') diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html b/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html new file mode 100644 index 0000000..44a82a8 --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v_ga61381bd30fb6630b6c5d6ecc8968e983.html @@ -0,0 +1,168 @@ + + + + + +UNICENS: Ucs_Stop + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
Logo +
UNICENS V2.1.0-3491
+
User Manual and API Reference
+ +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+ +
+
+ + + + + + + + + + + + + + + + + + +
Ucs_Return_t Ucs_Stop (Ucs_Inst_t * self,
Ucs_StdResultCb_t stopped_fptr 
)
+
+ +

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
+ + + +
selfThe instance
stopped_fptrMandatory 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
+
+ +
+
+
+
+ + + + + + -- cgit 1.2.3-korg