mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-05 05:27:58 +08:00
157 lines
4.4 KiB
Markdown
157 lines
4.4 KiB
Markdown
## conf\_xml\_t
|
||
### 概述
|
||
|
||
|
||
conf xml对象。
|
||
|
||
示例
|
||
|
||
```c
|
||
char filename[MAX_PATH + 1] = {0};
|
||
path_prepend_temp_path(filename, "test.xml");
|
||
|
||
const char *xml_data1 = "<root><name>awplc</name><age>18</age><weight>60.5</weight></root>";
|
||
ENSURE(file_write(filename, xml_data1, strlen(xml_data1)) == RET_OK);
|
||
|
||
// 从文件加载
|
||
tk_object_t *xml = conf_xml_load(filename, FALSE);
|
||
|
||
// 获取数据。注意：从文本节点获取数据，需要加上@text
|
||
ENSURE(tk_str_eq(tk_object_get_prop_str(xml, "root.name.@text"), "awplc"));
|
||
ENSURE(tk_object_get_prop_int(xml, "root.age.@text", 0) == 18);
|
||
ENSURE(tk_object_get_prop_double(xml, "root.weight.@text", 0) == 60.5);
|
||
|
||
// 销毁对象
|
||
TK_OBJECT_UNREF(xml);
|
||
|
||
// 从内存加载
|
||
const char *xml_data2 = "<root name=\"awplc\" age=\"18\" weight=\"60.5\"></root>";
|
||
xml = conf_xml_load_from_buff(xml_data2, strlen(xml_data2), FALSE);
|
||
|
||
// 获取数据
|
||
ENSURE(tk_str_eq(tk_object_get_prop_str(xml, "root.name"), "awplc"));
|
||
ENSURE(tk_object_get_prop_int(xml, "root.age", 0) == 18);
|
||
ENSURE(tk_object_get_prop_double(xml, "root.weight", 0) == 60.5);
|
||
|
||
// 设置数据
|
||
ENSURE(tk_object_set_prop_int(xml, "root.age", 20) == RET_OK);
|
||
ENSURE(tk_object_get_prop_int(xml, "root.age", 0) == 20);
|
||
|
||
// 保存到文件
|
||
ENSURE(conf_xml_save_as(xml, filename) == RET_OK);
|
||
ENSURE(file_exist(filename) == TRUE);
|
||
|
||
// 销毁对象
|
||
TK_OBJECT_UNREF(xml);
|
||
```
|
||
----------------------------------
|
||
### 函数
|
||
<p id="conf_xml_t_methods">
|
||
|
||
| 函数名称 | 说明 |
|
||
| -------- | ------------ |
|
||
| <a href="#conf_xml_t_conf_xml_create">conf\_xml\_create</a> | 创建一个空的conf对象。 |
|
||
| <a href="#conf_xml_t_conf_xml_load">conf\_xml\_load</a> | 从指定URL加载XML对象。 |
|
||
| <a href="#conf_xml_t_conf_xml_load_from_buff">conf\_xml\_load\_from\_buff</a> | 从内存加载XML对象。 |
|
||
| <a href="#conf_xml_t_conf_xml_save_as">conf\_xml\_save\_as</a> | 将doc对象保存到指定URL。 |
|
||
| <a href="#conf_xml_t_conf_xml_save_to_buff">conf\_xml\_save\_to\_buff</a> | 将obj保存为XML格式到内存。 |
|
||
#### conf\_xml\_create 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_xml_t_conf_xml_create">创建一个空的conf对象。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
tk_object_t* conf_xml_create ();
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||
#### conf\_xml\_load 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_xml_t_conf_xml_load">从指定URL加载XML对象。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
tk_object_t* conf_xml_load (const char* url, bool_t create_if_not_exist);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||
| url | const char* | 路径(通常是文件路径)。 |
|
||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||
#### conf\_xml\_load\_from\_buff 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_xml_t_conf_xml_load_from_buff">从内存加载XML对象。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
tk_object_t* conf_xml_load_from_buff (const void* buff, uint32_t size, bool_t create_if_not_exist);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||
| buff | const void* | 数据。 |
|
||
| size | uint32\_t | 数据长度。 |
|
||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||
#### conf\_xml\_save\_as 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_xml_t_conf_xml_save_as">将doc对象保存到指定URL。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
ret_t conf_xml_save_as (tk_object_t* obj, const char* url);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败 |
|
||
| obj | tk\_object\_t* | doc对象。 |
|
||
| url | const char* | 保存的位置。 |
|
||
#### conf\_xml\_save\_to\_buff 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_xml_t_conf_xml_save_to_buff">将obj保存为XML格式到内存。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
ret_t conf_xml_save_to_buff (tk_object_t* obj, wbuffer_t* wb);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败 |
|
||
| obj | tk\_object\_t* | doc对象。 |
|
||
| wb | wbuffer\_t* | 返回结果(不要初始化，使用完成后要调用wbuffer\_deinit)。 |
|