diff --git a/docs/manual/conf_ini_t.md b/docs/manual/conf_ini_t.md index 40742ed4e..0e3906db8 100644 --- a/docs/manual/conf_ini_t.md +++ b/docs/manual/conf_ini_t.md @@ -11,7 +11,9 @@ conf ini对象。 | -------- | ------------ | | conf\_ini\_create | 创建一个空的conf对象。 | | conf\_ini\_load | 从指定URL加载INI对象。 | +| conf\_ini\_load\_from\_buff | 从内存加载INI对象。 | | conf\_ini\_save\_as | 将doc对象保存到指定URL。 | +| conf\_ini\_save\_to\_buff | 将obj保存为INI格式到内存。 | #### conf\_ini\_create 函数 ----------------------- @@ -50,6 +52,27 @@ tk_object_t* conf_ini_load (const char* url, bool_t create_if_not_exist); | 返回值 | tk\_object\_t* | 返回配置对象。 | | url | const char* | 路径(通常是文件路径)。 | | create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | +#### conf\_ini\_load\_from\_buff 函数 +----------------------- + +* 函数功能: + +>

从内存加载INI对象。 + +* 函数原型: + +``` +tk_object_t* conf_ini_load_from_buff (const void* buff, uint32_t size, bool_t create_if_not_exist); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | tk\_object\_t* | 返回配置对象。 | +| buff | const void* | 数据。 | +| size | uint32\_t | 数据长度。 | +| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | #### conf\_ini\_save\_as 函数 ----------------------- @@ -70,3 +93,23 @@ ret_t conf_ini_save_as (tk_object_t* obj, const char* url); | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | | obj | tk\_object\_t* | doc对象。 | | url | const char* | 保存的位置。 | +#### conf\_ini\_save\_to\_buff 函数 +----------------------- + +* 函数功能: + +>

将obj保存为INI格式到内存。 + +* 函数原型: + +``` +ret_t conf_ini_save_to_buff (tk_object_t* obj, wbuffer_t* wb); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | +| obj | tk\_object\_t* | doc对象。 | +| wb | wbuffer\_t* | 返回结果(不要初始化,使用完成后要调用wbuffer\_deinit)。 | diff --git a/docs/manual/conf_json_t.md b/docs/manual/conf_json_t.md index 7c30abce5..dde1ec611 100644 --- a/docs/manual/conf_json_t.md +++ b/docs/manual/conf_json_t.md @@ -11,7 +11,9 @@ conf json对象。 | -------- | ------------ | | conf\_json\_create | 创建一个空的conf对象。 | | conf\_json\_load | 从指定URL加载JSON对象。 | +| conf\_json\_load\_from\_buff | 从内存加载JSON对象。 | | conf\_json\_save\_as | 将doc对象保存到指定URL。 | +| conf\_json\_save\_to\_buff | 将obj保存为JSON格式到内存。 | #### conf\_json\_create 函数 ----------------------- @@ -50,6 +52,27 @@ tk_object_t* conf_json_load (const char* url, bool_t create_if_not_exist); | 返回值 | tk\_object\_t* | 返回配置对象。 | | url | const char* | 路径(通常是文件路径)。 | | create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | +#### conf\_json\_load\_from\_buff 函数 +----------------------- + +* 函数功能: + +>

从内存加载JSON对象。 + +* 函数原型: + +``` +tk_object_t* conf_json_load_from_buff (const void* buff, uint32_t size, bool_t create_if_not_exist); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | tk\_object\_t* | 返回配置对象。 | +| buff | const void* | 数据。 | +| size | uint32\_t | 数据长度。 | +| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | #### conf\_json\_save\_as 函数 ----------------------- @@ -70,3 +93,23 @@ ret_t conf_json_save_as (tk_object_t* obj, const char* url); | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | | obj | tk\_object\_t* | doc对象。 | | url | const char* | 保存的位置。 | +#### conf\_json\_save\_to\_buff 函数 +----------------------- + +* 函数功能: + +>

将obj保存为JSON格式到内存。 + +* 函数原型: + +``` +ret_t conf_json_save_to_buff (tk_object_t* obj, wbuffer_t* wb); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | +| obj | tk\_object\_t* | doc对象。 | +| wb | wbuffer\_t* | 返回结果(不要初始化,使用完成后要调用wbuffer\_deinit)。 | diff --git a/docs/manual/conf_ubjson_t.md b/docs/manual/conf_ubjson_t.md index 2c4a9213f..a32ea9561 100644 --- a/docs/manual/conf_ubjson_t.md +++ b/docs/manual/conf_ubjson_t.md @@ -11,7 +11,9 @@ conf json对象。 | -------- | ------------ | | conf\_ubjson\_create | 创建一个空的conf对象。 | | conf\_ubjson\_load | 从指定URL加载UBJSON对象。 | +| conf\_ubjson\_load\_from\_buff | 从内存加载UBJSON对象。 | | conf\_ubjson\_save\_as | 将doc对象保存到指定URL。 | +| conf\_ubjson\_save\_to\_buff | 将obj保存为UBJSON格式到内存。 | #### conf\_ubjson\_create 函数 ----------------------- @@ -50,6 +52,27 @@ tk_object_t* conf_ubjson_load (const char* url, bool_t create_if_not_exist); | 返回值 | tk\_object\_t* | 返回配置对象。 | | url | const char* | 路径(通常是文件路径)。 | | create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | +#### conf\_ubjson\_load\_from\_buff 函数 +----------------------- + +* 函数功能: + +>

从内存加载UBJSON对象。 + +* 函数原型: + +``` +tk_object_t* conf_ubjson_load_from_buff (const void* buff, uint32_t size, bool_t create_if_not_exist); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | tk\_object\_t* | 返回配置对象。 | +| buff | const void* | 数据。 | +| size | uint32\_t | 数据长度。 | +| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | #### conf\_ubjson\_save\_as 函数 ----------------------- @@ -70,3 +93,23 @@ ret_t conf_ubjson_save_as (tk_object_t* obj, const char* url); | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | | obj | tk\_object\_t* | doc对象。 | | url | const char* | 保存的位置。 | +#### conf\_ubjson\_save\_to\_buff 函数 +----------------------- + +* 函数功能: + +>

将obj保存为UBJSON格式到内存。 + +* 函数原型: + +``` +ret_t conf_ubjson_save_to_buff (tk_object_t* obj, wbuffer_t* wb); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | +| obj | tk\_object\_t* | doc对象。 | +| wb | wbuffer\_t* | 返回结果(不要初始化,使用完成后要调用wbuffer\_deinit)。 | diff --git a/docs/manual/conf_xml_t.md b/docs/manual/conf_xml_t.md index f2592cef9..02bc1f1a5 100644 --- a/docs/manual/conf_xml_t.md +++ b/docs/manual/conf_xml_t.md @@ -11,7 +11,9 @@ conf xml对象。 | -------- | ------------ | | conf\_xml\_create | 创建一个空的conf对象。 | | conf\_xml\_load | 从指定URL加载XML对象。 | +| conf\_xml\_load\_from\_buff | 从内存加载XML对象。 | | conf\_xml\_save\_as | 将doc对象保存到指定URL。 | +| conf\_xml\_save\_to\_buff | 将obj保存为XML格式到内存。 | #### conf\_xml\_create 函数 ----------------------- @@ -50,6 +52,27 @@ tk_object_t* conf_xml_load (const char* url, bool_t create_if_not_exist); | 返回值 | tk\_object\_t* | 返回配置对象。 | | url | const char* | 路径(通常是文件路径)。 | | create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | +#### conf\_xml\_load\_from\_buff 函数 +----------------------- + +* 函数功能: + +>

从内存加载XML对象。 + +* 函数原型: + +``` +tk_object_t* conf_xml_load_from_buff (const void* buff, uint32_t size, bool_t create_if_not_exist); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | tk\_object\_t* | 返回配置对象。 | +| buff | const void* | 数据。 | +| size | uint32\_t | 数据长度。 | +| create\_if\_not\_exist | bool\_t | 如果不存在是否创建。 | #### conf\_xml\_save\_as 函数 ----------------------- @@ -70,3 +93,23 @@ ret_t conf_xml_save_as (tk_object_t* obj, const char* url); | 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | | obj | tk\_object\_t* | doc对象。 | | url | const char* | 保存的位置。 | +#### conf\_xml\_save\_to\_buff 函数 +----------------------- + +* 函数功能: + +>

将obj保存为XML格式到内存。 + +* 函数原型: + +``` +ret_t conf_xml_save_to_buff (tk_object_t* obj, wbuffer_t* wb); +``` + +* 参数说明: + +| 参数 | 类型 | 说明 | +| -------- | ----- | --------- | +| 返回值 | ret\_t | 返回RET\_OK表示成功,否则表示失败 | +| obj | tk\_object\_t* | doc对象。 | +| wb | wbuffer\_t* | 返回结果(不要初始化,使用完成后要调用wbuffer\_deinit)。 |