mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-11-30 02:58:26 +08:00
Merge branch 'master' of https://github.com/zlgopen/awtk
This commit is contained in:
lixianjing
commit
2da8f3ab2b
423
docs/manual/app_conf_t.md
Normal file
423
docs/manual/app_conf_t.md
Normal file
@ -0,0 +1,423 @@
|
||||
## app\_conf\_t
|
||||
### 概述
|
||||
应用程序的配置信息。
|
||||
|
||||
底层实现可以是任何格式，比如INI，XML，JSON和UBJSON。
|
||||
|
||||
对于树状的文档，key可以是多级的，用.分隔。如network.ip。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="app_conf_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#app_conf_t_app_conf_deinit">app\_conf\_deinit</a> | 释放conf对象。 |
|
||||
| <a href="#app_conf_t_app_conf_exist">app\_conf\_exist</a> | 检查配置项是否存在。 |
|
||||
| <a href="#app_conf_t_app_conf_get">app\_conf\_get</a> | 获取配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_get_bool">app\_conf\_get\_bool</a> | 获取bool类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_get_double">app\_conf\_get\_double</a> | 获取单精度浮点数类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_get_int">app\_conf\_get\_int</a> | 获取整数类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_get_int64">app\_conf\_get\_int64</a> | 获取64位整数类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_get_str">app\_conf\_get\_str</a> | 获取字符串类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_off_changed">app\_conf\_off\_changed</a> | 注销配置变化事件。 |
|
||||
| <a href="#app_conf_t_app_conf_off_changed_by_ctx">app\_conf\_off\_changed\_by\_ctx</a> | 注销配置变化事件。 |
|
||||
| <a href="#app_conf_t_app_conf_on_changed">app\_conf\_on\_changed</a> | 注册配置变化事件。 |
|
||||
| <a href="#app_conf_t_app_conf_remove">app\_conf\_remove</a> | 删除配置项。 |
|
||||
| <a href="#app_conf_t_app_conf_save">app\_conf\_save</a> | 保存配置。 |
|
||||
| <a href="#app_conf_t_app_conf_set">app\_conf\_set</a> | 设置配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_set_bool">app\_conf\_set\_bool</a> | 设置bool类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_set_double">app\_conf\_set\_double</a> | 设置双精度类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_set_instance">app\_conf\_set\_instance</a> | 初始化。 |
|
||||
| <a href="#app_conf_t_app_conf_set_int">app\_conf\_set\_int</a> | 设置整数类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_set_int64">app\_conf\_set\_int64</a> | 设置64位整数类型配置项的值。 |
|
||||
| <a href="#app_conf_t_app_conf_set_str">app\_conf\_set\_str</a> | 设置字符串类型配置项的值。 |
|
||||
#### app\_conf\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_deinit">释放conf对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_deinit ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### app\_conf\_exist 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_exist">检查配置项是否存在。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t app_conf_exist (const char* key);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示存在，FALSE表示不存在。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
#### app\_conf\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_get">获取配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_get (const char* key, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | value\_t* | 配置项的值(用于返回)。 |
|
||||
#### app\_conf\_get\_bool 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_get_bool">获取bool类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t app_conf_get_bool (const char* key, bool_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回配置项的值（如果不存在返回缺省值）。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| defval | bool\_t | 缺省值。 |
|
||||
#### app\_conf\_get\_double 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_get_double">获取单精度浮点数类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
double app_conf_get_double (const char* key, double defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | double | 返回配置项的值（如果不存在返回缺省值）。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| defval | double | 缺省值。 |
|
||||
#### app\_conf\_get\_int 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_get_int">获取整数类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t app_conf_get_int (const char* key, int32_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回配置项的值（如果不存在返回缺省值）。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| defval | int32\_t | 缺省值。 |
|
||||
#### app\_conf\_get\_int64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_get_int64">获取64位整数类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int64_t app_conf_get_int64 (const char* key, int64_t defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int64\_t | 返回配置项的值（如果不存在返回缺省值）。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| defval | int64\_t | 缺省值。 |
|
||||
#### app\_conf\_get\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_get_str">获取字符串类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* app_conf_get_str (const char* key, const char* defval);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回配置项的值（如果不存在返回缺省值）。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| defval | const char* | 缺省值。 |
|
||||
#### app\_conf\_off\_changed 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_off_changed">注销配置变化事件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_off_changed ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### app\_conf\_off\_changed\_by\_ctx 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_off_changed_by_ctx">注销配置变化事件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_off_changed_by_ctx (void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| ctx | void* | 事件处理函数上下文。 |
|
||||
#### app\_conf\_on\_changed 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_on_changed">注册配置变化事件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t app_conf_on_changed (event_func_t on_event, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回id，用于app\_conf\_off\_changed。 |
|
||||
| on\_event | event\_func\_t | 事件处理函数。 |
|
||||
| ctx | void* | 事件处理函数上下文。 |
|
||||
#### app\_conf\_remove 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_remove">删除配置项。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_remove (const char* key);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
#### app\_conf\_save 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_save">保存配置。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_save ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### app\_conf\_set 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set">设置配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set (const char* key, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | const value\_t* | 配置项的值。 |
|
||||
#### app\_conf\_set\_bool 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set_bool">设置bool类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set_bool (const char* key, bool_t v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | bool\_t | 配置项的值。 |
|
||||
#### app\_conf\_set\_double 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set_double">设置双精度类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set_double (const char* key, double v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | double | 配置项的值。 |
|
||||
#### app\_conf\_set\_instance 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set_instance">初始化。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set_instance (object_t* );
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| | object\_t* | 。 |
|
||||
#### app\_conf\_set\_int 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set_int">设置整数类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set_int (const char* key, int32_t v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | int32\_t | 配置项的值。 |
|
||||
#### app\_conf\_set\_int64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set_int64">设置64位整数类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set_int64 (const char* key, int64_t v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | int64\_t | 配置项的值。 |
|
||||
#### app\_conf\_set\_str 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="app_conf_t_app_conf_set_str">设置字符串类型配置项的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t app_conf_set_str (const char* key, const char* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| key | const char* | 配置项的名称。 |
|
||||
| v | const char* | 配置项的值。 |
|
||||
320
docs/manual/conf_doc_t.md
Normal file
320
docs/manual/conf_doc_t.md
Normal file
@ -0,0 +1,320 @@
|
||||
## conf\_doc\_t
|
||||
### 概述
|
||||
代表整个配置文件。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="conf_doc_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_doc_t_conf_doc_append_child">conf\_doc\_append\_child</a> | 追加一个子节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_append_sibling">conf\_doc\_append\_sibling</a> | 追加一个兄弟节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_create">conf\_doc\_create</a> | 构造函数。 |
|
||||
| <a href="#conf_doc_t_conf_doc_create_node">conf\_doc\_create\_node</a> | 创建一个空节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_destroy">conf\_doc\_destroy</a> | 析构函数。 |
|
||||
| <a href="#conf_doc_t_conf_doc_destroy_node">conf\_doc\_destroy\_node</a> | 销毁节点对象。 |
|
||||
| <a href="#conf_doc_t_conf_doc_exists">conf\_doc\_exists</a> | 判断指定路径的节点是否存在。 |
|
||||
| <a href="#conf_doc_t_conf_doc_get">conf\_doc\_get</a> | 获取指定路径节点的值。 |
|
||||
| <a href="#conf_doc_t_conf_doc_remove">conf\_doc\_remove</a> | 删除指定路径的节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_remove_child">conf\_doc\_remove\_child</a> | 删除指定的子节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_remove_child_by_name">conf\_doc\_remove\_child\_by\_name</a> | 删除指定的子节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_remove_children">conf\_doc\_remove\_children</a> | 删除全部子节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_remove_sibling">conf\_doc\_remove\_sibling</a> | 删除指定的兄弟节点。 |
|
||||
| <a href="#conf_doc_t_conf_doc_set">conf\_doc\_set</a> | 设置指定路径节点的值。 |
|
||||
### 属性
|
||||
<p id="conf_doc_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#conf_doc_t_root">root</a> | conf\_node\_t* | 根节点。 |
|
||||
#### conf\_doc\_append\_child 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_append_child">追加一个子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_append_child (conf_doc_t* doc, conf_node_t* node, conf_node_t* child);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| child | conf\_node\_t* | 待追加节点对象。 |
|
||||
#### conf\_doc\_append\_sibling 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_append_sibling">追加一个兄弟节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_append_sibling (conf_doc_t* doc, conf_node_t* node, conf_node_t* sibling);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| sibling | conf\_node\_t* | 待追加节点对象。 |
|
||||
#### conf\_doc\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_create">构造函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
conf_doc_t* conf_doc_create (uint32_t prealloc_nodes_nr);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | conf\_doc\_t* | 返回doc对象。 |
|
||||
| prealloc\_nodes\_nr | uint32\_t | 预先分配的节点数。 |
|
||||
#### conf\_doc\_create\_node 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_create_node">创建一个空节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
conf_node_t* conf_doc_create_node (conf_doc_t* doc, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | conf\_node\_t* | 返回节点对象。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| name | const char* | 节点名称。 |
|
||||
#### conf\_doc\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_destroy">析构函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_destroy (conf_doc_t* doc);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
#### conf\_doc\_destroy\_node 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_destroy_node">销毁节点对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_destroy_node (conf_doc_t* doc, conf_node_t* node);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
#### conf\_doc\_exists 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_exists">判断指定路径的节点是否存在。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
bool_t conf_doc_exists (conf_doc_t* doc, const char* path);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | bool\_t | 返回TRUE表示成功，FALSE表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| path | const char* | 节点的路径。 |
|
||||
#### conf\_doc\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_get">获取指定路径节点的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_get (conf_doc_t* doc, const char* path, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| path | const char* | 节点的路径。 |
|
||||
| v | value\_t* | 用于返回值。 |
|
||||
#### conf\_doc\_remove 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_remove">删除指定路径的节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_remove (conf_doc_t* doc, const char* path);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| path | const char* | 节点的路径。 |
|
||||
#### conf\_doc\_remove\_child 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_remove_child">删除指定的子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_remove_child (conf_doc_t* doc, conf_node_t* node, conf_node_t* child);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| child | conf\_node\_t* | 待删除节点对象。 |
|
||||
#### conf\_doc\_remove\_child\_by\_name 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_remove_child_by_name">删除指定的子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_remove_child_by_name (conf_doc_t* doc, conf_node_t* node, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| name | const char* | 待删除节点的名称。 |
|
||||
#### conf\_doc\_remove\_children 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_remove_children">删除全部子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_remove_children (conf_doc_t* doc, conf_node_t* node);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
#### conf\_doc\_remove\_sibling 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_remove_sibling">删除指定的兄弟节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_remove_sibling (conf_doc_t* doc, conf_node_t* node, conf_node_t* sibling);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| sibling | conf\_node\_t* | 待删除节点对象。 |
|
||||
#### conf\_doc\_set 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_doc_t_conf_doc_set">设置指定路径节点的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_doc_set (conf_doc_t* doc, const char* path, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| doc | conf\_doc\_t* | 文档对象。 |
|
||||
| path | const char* | 节点的路径。 |
|
||||
| v | const value\_t* | 值。 |
|
||||
#### root 属性
|
||||
-----------------------
|
||||
> <p id="conf_doc_t_root">根节点。
|
||||
|
||||
* 类型：conf\_node\_t*
|
||||
|
||||
32
docs/manual/conf_ini_t.md
Normal file
32
docs/manual/conf_ini_t.md
Normal file
@ -0,0 +1,32 @@
|
||||
## conf\_ini\_t
|
||||
### 概述
|
||||
|
||||
|
||||
conf ini对象。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="conf_ini_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_ini_t_conf_ini_load">conf\_ini\_load</a> | |
|
||||
#### conf\_ini\_load 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_ini_t_conf_ini_load">
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_ini_load (const char* url, bool_t create_if_not_exist);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
| url | const char* | 路径(通常是文件路径)。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
53
docs/manual/conf_json_t.md
Normal file
53
docs/manual/conf_json_t.md
Normal file
@ -0,0 +1,53 @@
|
||||
## conf\_json\_t
|
||||
### 概述
|
||||
|
||||
|
||||
conf json对象。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="conf_json_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_json_t_conf_json_load">conf\_json\_load</a> | |
|
||||
| <a href="#conf_json_t_conf_json_load">conf\_json\_load</a> | |
|
||||
#### conf\_json\_load 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_json_t_conf_json_load">
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_json_load (const char* url, bool_t create_if_not_exist);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
| url | const char* | 路径(通常是文件路径)。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
#### conf\_json\_load 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_json_t_conf_json_load">
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_json_load (const char* url, bool_t create_if_not_exist);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
| url | const char* | 路径(通常是文件路径)。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
187
docs/manual/conf_node_t.md
Normal file
187
docs/manual/conf_node_t.md
Normal file
@ -0,0 +1,187 @@
|
||||
## conf\_node\_t
|
||||
### 概述
|
||||
节点。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="conf_node_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_node_t_conf_node_find_child">conf\_node\_find\_child</a> | 查找指定名称的子节点。 |
|
||||
| <a href="#conf_node_t_conf_node_find_sibling">conf\_node\_find\_sibling</a> | 查找指定名称的兄弟节点。 |
|
||||
| <a href="#conf_node_t_conf_node_get_name">conf\_node\_get\_name</a> | 获得节点的名称。 |
|
||||
| <a href="#conf_node_t_conf_node_get_value">conf\_node\_get\_value</a> | 设置节点的值。 |
|
||||
| <a href="#conf_node_t_conf_node_set_first_child">conf\_node\_set\_first\_child</a> | 获取第一个子节点。 |
|
||||
| <a href="#conf_node_t_conf_node_set_first_child">conf\_node\_set\_first\_child</a> | 设置第一个子节点。 |
|
||||
| <a href="#conf_node_t_conf_node_set_value">conf\_node\_set\_value</a> | 设置节点的值。 |
|
||||
### 属性
|
||||
<p id="conf_node_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#conf_node_t_next">next</a> | conf\_node\_t* | 下一个兄弟节点。 |
|
||||
| <a href="#conf_node_t_node_type">node\_type</a> | uint8\_t | 节点类型。 |
|
||||
| <a href="#conf_node_t_parent">parent</a> | conf\_node\_t* | 父节点。 |
|
||||
| <a href="#conf_node_t_value_type">value\_type</a> | uint8\_t | 值的类型。 |
|
||||
#### conf\_node\_find\_child 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_find_child">查找指定名称的子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
conf_node_t* conf_node_find_child (conf_node_t* node, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | conf\_node\_t* | 返回节点对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| name | const char* | 节点名称。 |
|
||||
#### conf\_node\_find\_sibling 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_find_sibling">查找指定名称的兄弟节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
conf_node_t* conf_node_find_sibling (conf_node_t* node, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | conf\_node\_t* | 返回节点对象。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| name | const char* | 节点名称。 |
|
||||
#### conf\_node\_get\_name 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_get_name">获得节点的名称。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* conf_node_get_name (conf_node_t* node);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回节点名称。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
#### conf\_node\_get\_value 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_get_value">设置节点的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_node_get_value (conf_node_t* node, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| v | value\_t* | 值(返回)。 |
|
||||
#### conf\_node\_set\_first\_child 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_set_first_child">获取第一个子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
conf_node_t* conf_node_set_first_child (conf_node_t* node);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | conf\_node\_t* | 返回第一个子节点。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
#### conf\_node\_set\_first\_child 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_set_first_child">设置第一个子节点。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_node_set_first_child (conf_node_t* node, conf_node_t* child);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| child | conf\_node\_t* | 子节点对象。 |
|
||||
#### conf\_node\_set\_value 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_node_t_conf_node_set_value">设置节点的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_node_set_value (conf_node_t* node, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| node | conf\_node\_t* | 节点对象。 |
|
||||
| v | const value\_t* | 值。 |
|
||||
#### next 属性
|
||||
-----------------------
|
||||
> <p id="conf_node_t_next">下一个兄弟节点。
|
||||
|
||||
* 类型：conf\_node\_t*
|
||||
|
||||
#### node\_type 属性
|
||||
-----------------------
|
||||
> <p id="conf_node_t_node_type">节点类型。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
#### parent 属性
|
||||
-----------------------
|
||||
> <p id="conf_node_t_parent">父节点。
|
||||
|
||||
* 类型：conf\_node\_t*
|
||||
|
||||
#### value\_type 属性
|
||||
-----------------------
|
||||
> <p id="conf_node_t_value_type">值的类型。
|
||||
|
||||
* 类型：uint8\_t
|
||||
|
||||
11
docs/manual/conf_node_type_t.md
Normal file
11
docs/manual/conf_node_type_t.md
Normal file
@ -0,0 +1,11 @@
|
||||
## conf\_node\_type\_t
|
||||
### 概述
|
||||
节点类型。### 常量
|
||||
<p id="conf_node_type_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| CONF\_NODE\_NONE | 无效节点。 |
|
||||
| CONF\_NODE\_OBJECT | 对象节点。 |
|
||||
| CONF\_NODE\_ARRAY | 数组节点。 |
|
||||
| CONF\_NODE\_SIMPLE | 简单节点。 |
|
||||
22
docs/manual/conf_node_value_t.md
Normal file
22
docs/manual/conf_node_value_t.md
Normal file
@ -0,0 +1,22 @@
|
||||
## conf\_node\_value\_t
|
||||
### 概述
|
||||
节点值得类型。### 常量
|
||||
<p id="conf_node_value_t_consts">
|
||||
|
||||
| 名称 | 说明 |
|
||||
| -------- | ------- |
|
||||
| CONF\_NODE\_VALUE\_NONE | 无效类型。 |
|
||||
| CONF\_NODE\_VALUE\_BOOL | bool\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_INT8 | int8\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_UINT8 | uint8\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_INT16 | int16\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_UINT16 | uint16\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_INT32 | int32\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_UINT32 | uint32\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_INT64 | int64\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_UINT64 | uint64\_t类型。 |
|
||||
| CONF\_NODE\_VALUE\_FLOAT32 | float类型。 |
|
||||
| CONF\_NODE\_VALUE\_DOUBLE | double类型。 |
|
||||
| CONF\_NODE\_VALUE\_STRING | 字符串类型。 |
|
||||
| CONF\_NODE\_VALUE\_SMALL\_STR | 短字符(len<=7)串类型。 |
|
||||
| CONF\_NODE\_VALUE\_NODE | 节点类型。 |
|
||||
74
docs/manual/conf_obj_t.md
Normal file
74
docs/manual/conf_obj_t.md
Normal file
@ -0,0 +1,74 @@
|
||||
## conf\_obj\_t
|
||||
### 概述
|
||||
|
||||
|
||||
conf对象。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="conf_obj_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_obj_t_conf_obj_create">conf\_obj\_create</a> | |
|
||||
| <a href="#conf_obj_t_conf_obj_get_doc">conf\_obj\_get\_doc</a> | 获取doc对象，用于更高级的操作。 |
|
||||
| <a href="#conf_obj_t_conf_obj_save">conf\_obj\_save</a> | 保存文档。 |
|
||||
#### conf\_obj\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_obj_t_conf_obj_create">
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_obj_create (conf_doc_save_t save, conf_doc_load_t load, const char* url, bool_t create_if_not_exist);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
| save | conf\_doc\_save\_t | 保存函数。 |
|
||||
| load | conf\_doc\_load\_t | 加载函数。 |
|
||||
| url | const char* | 路径。 |
|
||||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||||
#### conf\_obj\_get\_doc 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_obj_t_conf_obj_get_doc">获取doc对象，用于更高级的操作。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
conf_dot_t conf_obj_get_doc (object_t* conf);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | conf\_dot\_t | 返回doc对象。 |
|
||||
| conf | object\_t* | conf对象。 |
|
||||
#### conf\_obj\_save 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_obj_t_conf_obj_save">保存文档。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t conf_obj_save (object_t* conf);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败 |
|
||||
| conf | object\_t* | conf对象。 |
|
||||
BIN
docs/manual/images/conf_ini_t_0.png
Normal file
BIN
docs/manual/images/conf_ini_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
BIN
docs/manual/images/conf_json_t_0.png
Normal file
BIN
docs/manual/images/conf_json_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
BIN
docs/manual/images/conf_obj_t_0.png
Normal file
BIN
docs/manual/images/conf_obj_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.9 KiB |
Loading…
Reference in New Issue
Block a user