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

5.0 KiB
Raw Blame History

conf_node_t

概述

节点。

函数

函数名称 说明
conf_node_find_child 查找指定名称的子节点。
conf_node_find_sibling 查找指定名称的兄弟节点。
conf_node_get_first_child 获取第一个子节点。
conf_node_get_name 获得节点的名称。
conf_node_get_value 设置节点的值。
conf_node_set_first_child 设置第一个子节点。
conf_node_set_value 设置节点的值。

属性

属性名称 类型 说明
next conf_node_t* 下一个兄弟节点。
node_type uint8_t 节点类型。
parent conf_node_t* 父节点。
value_type uint8_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 函数


  • 函数功能:

查找指定名称的兄弟节点。

  • 函数原型:
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 函数


  • 函数功能:

获取第一个子节点。

  • 函数原型:
conf_node_t* conf_node_get_first_child (conf_node_t* node);
  • 参数说明:
参数 类型 说明
返回值 conf_node_t* 返回第一个子节点。
node 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 函数


  • 函数功能:

设置节点的值。

  • 函数原型:
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 函数


  • 函数功能:

设置第一个子节点。

  • 函数原型:
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 函数


  • 函数功能:

设置节点的值。

  • 函数原型:
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 属性


下一个兄弟节点。

  • 类型conf_node_t*

node_type 属性


节点类型。

  • 类型uint8_t

parent 属性


父节点。

  • 类型conf_node_t*

value_type 属性


值的类型。

  • 类型uint8_t