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 --- ..._c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html | 224 +++++++++++++++++++++ 1 file changed, 224 insertions(+) create mode 100644 ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html (limited to 'ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html') diff --git a/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html b/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html new file mode 100644 index 0000000..168cffa --- /dev/null +++ b/ucs2-lib/doc/html/group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s.html @@ -0,0 +1,224 @@ + + + + + +UNICENS: Initialization and Service Types + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
Logo +
UNICENS V2.1.0-3491
+
User Manual and API Reference
+ +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+ +
+
Initialization and Service Types
+
+
+ +

Referred types used by basic functions. +More...

+ + + + + + + + + + + +

+Data Structures

struct  Ucs_General_InitData_t
 The general section of initialization data. More...
 
struct  Ucs_Nd_InitData_t
 The initialization data of the Node Discovery service. More...
 
struct  Ucs_StdResult_t
 Standard result structure which provides fields for detailed status and error information. More...
 
+ + + + + + + + + + +

+Callback Functions

typedef struct Ucs_Inst_ Ucs_Inst_t
 UNICENS instance.
 
typedef void(* Ucs_StdResultCb_t )(Ucs_StdResult_t result, void *user_ptr)
 Function signature used for UNICENS standard result callbacks.
 
typedef void(* Ucs_InitResultCb_t )(Ucs_InitResult_t result, void *user_ptr)
 Function signature used for UNICENS standard result callbacks.
 
+ + + + + + + + + + + + + +

+Enumerations

enum  Ucs_Error_t {
+  UCS_GEN_ERR_COMMUNICATION = 1, +
+  UCS_GEN_ERR_INIC = 2 +
+ }
 UNICENS general error codes. More...
 
enum  Ucs_Return_t {
+  UCS_RET_SUCCESS = 0x00, +
+  UCS_RET_ERR_PARAM = 0x01, +
+  UCS_RET_ERR_BUFFER_OVERFLOW = 0x02, +
+  UCS_RET_ERR_NOT_AVAILABLE = 0x03, +
+  UCS_RET_ERR_NOT_SUPPORTED = 0x04, +
+  UCS_RET_ERR_INVALID_SHADOW = 0x05, +
+  UCS_RET_ERR_ALREADY_SET = 0x06, +
+  UCS_RET_ERR_API_LOCKED = 0x07, +
+  UCS_RET_ERR_NOT_INITIALIZED = 0x08 +
+ }
 Standard return codes used for synchronous response. More...
 
enum  Ucs_Result_t {
+  UCS_RES_SUCCESS = 0x00, +
+  UCS_RES_ERR_MOST_STANDARD = 0x01, +
+  UCS_RES_ERR_BUSY = 0x02, +
+  UCS_RES_ERR_PROCESSING = 0x03, +
+  UCS_RES_ERR_CONFIGURATION = 0x04, +
+  UCS_RES_ERR_SYSTEM = 0x05, +
+  UCS_RES_ERR_TIMEOUT = 0x06, +
+  UCS_RES_ERR_TRANSMISSION = 0x07 +
+ }
 Result codes used for asynchronous response. More...
 
enum  Ucs_InitResult_t {
+  UCS_INIT_RES_SUCCESS = 0x00U, +
+  UCS_INIT_RES_ERR_BUF_OVERFLOW = 0x01U, +
+  UCS_INIT_RES_ERR_INIC_SYNC = 0x02U, +
+  UCS_INIT_RES_ERR_INIC_VERSION = 0x03U, +
+  UCS_INIT_RES_ERR_INIC_SYSTEM = 0x04U, +
+  UCS_INIT_RES_ERR_DEV_ATT_CFG = 0x05U, +
+  UCS_INIT_RES_ERR_DEV_ATT_PROC = 0x06U, +
+  UCS_INIT_RES_ERR_NET_CFG = 0x07U, +
+  UCS_INIT_RES_ERR_INTERNAL = 0x0AU, +
+  UCS_INIT_RES_ERR_TIMEOUT = 0x0BU +
+ }
 Result values of initialization result callback function. More...
 
+

Detailed Description

+

Referred types used by basic functions.

+
+
+ + + + + + -- cgit 1.2.3-korg