awtk/docs/manual/conf_json_t.md
2021-01-11 08:23:05 +08:00

73 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## conf\_json\_t
### 概述
![image](images/conf_json_t_0.png)
conf json对象。
----------------------------------
### 函数
<p id="conf_json_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#conf_json_t_conf_json_create">conf\_json\_create</a> | 创建一个空的conf对象。 |
| <a href="#conf_json_t_conf_json_load">conf\_json\_load</a> | 从指定URL加载JSON对象。 |
| <a href="#conf_json_t_conf_json_save_as">conf\_json\_save\_as</a> | 将doc对象保存到指定URL。 |
#### conf\_json\_create 函数
-----------------------
* 函数功能:
> <p id="conf_json_t_conf_json_create">创建一个空的conf对象。
* 函数原型:
```
object_t* conf_json_create ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | object\_t* | 返回配置对象。 |
#### conf\_json\_load 函数
-----------------------
* 函数功能:
> <p id="conf_json_t_conf_json_load">从指定URL加载JSON对象。
* 函数原型:
```
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\_save\_as 函数
-----------------------
* 函数功能:
> <p id="conf_json_t_conf_json_save_as">将doc对象保存到指定URL。
* 函数原型:
```
ret_t conf_json_save_as (object_t* obj, const char* url);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败 |
| obj | object\_t* | doc对象。 |
| url | const char* | 保存的位置。 |