awtk/docs/manual/conf_ubjson_t.md

73 lines
1.9 KiB
Markdown
Raw Normal View History

2020-06-09 07:11:39 +08:00
## conf\_ubjson\_t
### 概述
![image](images/conf_ubjson_t_0.png)
conf json对象。
----------------------------------
### 函数
<p id="conf_ubjson_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2021-01-11 08:23:05 +08:00
| <a href="#conf_ubjson_t_conf_ubjson_create">conf\_ubjson\_create</a> | 创建一个空的conf对象。 |
| <a href="#conf_ubjson_t_conf_ubjson_load">conf\_ubjson\_load</a> | 从指定URL加载UBJSON对象。 |
2020-10-26 11:53:50 +08:00
| <a href="#conf_ubjson_t_conf_ubjson_save_as">conf\_ubjson\_save\_as</a> | 将doc对象保存到指定URL。 |
2021-01-11 08:23:05 +08:00
#### conf\_ubjson\_create 函数
-----------------------
* 函数功能:
> <p id="conf_ubjson_t_conf_ubjson_create">创建一个空的conf对象。
* 函数原型:
```
2022-12-05 12:10:53 +08:00
tk_object_t* conf_ubjson_create ();
2021-01-11 08:23:05 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
2022-12-05 12:10:53 +08:00
| 返回值 | tk\_object\_t* | 返回配置对象。 |
2020-06-09 07:11:39 +08:00
#### conf\_ubjson\_load 函数
-----------------------
* 函数功能:
2021-01-11 08:23:05 +08:00
> <p id="conf_ubjson_t_conf_ubjson_load">从指定URL加载UBJSON对象。
2020-06-09 07:11:39 +08:00
* 函数原型:
```
2022-12-05 12:10:53 +08:00
tk_object_t* conf_ubjson_load (const char* url, bool_t create_if_not_exist);
2020-06-09 07:11:39 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
2022-12-05 12:10:53 +08:00
| 返回值 | tk\_object\_t* | 返回配置对象。 |
2020-06-09 07:11:39 +08:00
| url | const char* | 路径(通常是文件路径)。 |
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
2020-10-26 11:53:50 +08:00
#### conf\_ubjson\_save\_as 函数
-----------------------
* 函数功能:
> <p id="conf_ubjson_t_conf_ubjson_save_as">将doc对象保存到指定URL。
* 函数原型:
```
2022-12-05 12:10:53 +08:00
ret_t conf_ubjson_save_as (tk_object_t* obj, const char* url);
2020-10-26 11:53:50 +08:00
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败 |
2022-12-05 12:10:53 +08:00
| obj | tk\_object\_t* | doc对象。 |
2020-10-26 11:53:50 +08:00
| url | const char* | 保存的位置。 |