mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-04 04:58:24 +08:00
141 lines
3.7 KiB
Markdown
141 lines
3.7 KiB
Markdown
## 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_create_ex">conf\_obj\_create\_ex</a> | |
|
||
| <a href="#conf_obj_t_conf_obj_create_sub_object">conf\_obj\_create\_sub\_object</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> | 保存文档。 |
|
||
| <a href="#conf_obj_t_conf_obj_set_readonly">conf\_obj\_set\_readonly</a> | 设置为只读模式。 |
|
||
#### conf\_obj\_create 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_obj_t_conf_obj_create">
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
tk_object_t* conf_obj_create (conf_doc_save_t save, conf_doc_load_t load, const char* url, bool_t create_if_not_exist);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||
| save | conf\_doc\_save\_t | 保存函数。 |
|
||
| load | conf\_doc\_load\_t | 加载函数。 |
|
||
| url | const char* | 路径。 |
|
||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||
#### conf\_obj\_create\_ex 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_obj_t_conf_obj_create_ex">
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
tk_object_t* conf_obj_create_ex (conf_doc_save_t save, conf_doc_load_t load, const char* url, bool_t create_if_not_exist, bool_t use_extend_type);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||
| save | conf\_doc\_save\_t | 保存函数。 |
|
||
| load | conf\_doc\_load\_t | 加载函数。 |
|
||
| url | const char* | 路径。 |
|
||
| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 |
|
||
| use\_extend\_type | bool\_t | 是否使用拓展类型。 |
|
||
#### conf\_obj\_create\_sub\_object 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_obj_t_conf_obj_create_sub_object">根据路径创建一个子对象。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
tk_object_t* conf_obj_create_sub_object (tk_object_t* conf, const char* path);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | tk\_object\_t* | 返回配置对象。 |
|
||
| conf | tk\_object\_t* | 配置对象。 |
|
||
| path | const char* | 路径。 |
|
||
#### conf\_obj\_get\_doc 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_obj_t_conf_obj_get_doc">获取doc对象，用于更高级的操作。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
conf_doc_t* conf_obj_get_doc (tk_object_t* conf);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | conf\_doc\_t* | 返回doc对象。 |
|
||
| conf | tk\_object\_t* | conf对象。 |
|
||
#### conf\_obj\_save 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_obj_t_conf_obj_save">保存文档。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
ret_t conf_obj_save (tk_object_t* conf);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败 |
|
||
| conf | tk\_object\_t* | conf对象。 |
|
||
#### conf\_obj\_set\_readonly 函数
|
||
-----------------------
|
||
|
||
* 函数功能：
|
||
|
||
> <p id="conf_obj_t_conf_obj_set_readonly">设置为只读模式。
|
||
|
||
* 函数原型：
|
||
|
||
```
|
||
ret_t conf_obj_set_readonly (tk_object_t* conf, bool_t readonly);
|
||
```
|
||
|
||
* 参数说明：
|
||
|
||
| 参数 | 类型 | 说明 |
|
||
| -------- | ----- | --------- |
|
||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败 |
|
||
| conf | tk\_object\_t* | conf对象。 |
|
||
| readonly | bool\_t | 只读模式。 |
|