awtk/docs/manual/conf_node_t.md
2020-06-18 21:54:25 +08:00

188 lines
5.0 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\_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_first_child">conf\_node\_get\_first\_child</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_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\_first\_child 函数
-----------------------
* 函数功能:
> <p id="conf_node_t_conf_node_get_first_child">获取第一个子节点。
* 函数原型:
```
conf_node_t* conf_node_get_first_child (conf_node_t* node);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | conf\_node\_t* | 返回第一个子节点。 |
| node | conf\_node\_t* | 节点对象。 |
#### 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">设置第一个子节点。
* 函数原型:
```
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