test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-11-29 18:48:09 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
lixianjing 2019-11-15 15:17:05 +08:00
parent edd5371040
commit 8e8d7f7c99
3 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/manual/fs_t.md
View File

@ -10,7 +10,7 @@
| -------- | ------------ |
| <a href="#fs_t_file_exist">file\_exist</a> | 判断文件是否存在。 |
| <a href="#fs_t_file_get_size">file\_get\_size</a> | 获取文件大小。 |
| <a href="#fs_t_file_read">file\_read</a> | 读取文件。 |
| <a href="#fs_t_file_read">file\_read</a> | 读取文件的全部内容。 |
| <a href="#fs_t_file_read_part">file\_read\_part</a> | 从某个位置读取文件。 |
| <a href="#fs_t_file_remove">file\_remove</a> | 刪除文件。 |
| <a href="#fs_t_file_write">file\_write</a> | 写入文件。 |
@ -57,36 +57,36 @@ ret_t file_exist (const char* name);
* 函数原型：
```
ret_t file_get_size (const char* name);
int32_t file_get_size (const char* name);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回不是-1表示成功，否则表示失败。 |
| 返回值 | int32\_t | 返回非负表示文件大小，否则表示失败。 |
| name | const char* | 文件名。 |
#### file\_read 函数
-----------------------
* 函数功能：
> <p id="fs_t_file_read">读取文件。
> <p id="fs_t_file_read">读取文件的全部内容。
* 函数原型：
```
int32_t* file_read (const char* name, uint32_t* size);
void* file_read (const char* name, uint32_t* size);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t* | 返回实际读取的字节数。 |
| 返回值 | void* | 返回读取的数据，需要调用TKMEM\_FREE释放。 |
| name | const char* | 文件名。 |
| size | uint32\_t* | 缓冲区大小。 |
| size | uint32\_t* | 返回实际读取的长度。 |
#### file\_read\_part 函数
-----------------------
@ -98,14 +98,14 @@ int32_t* file_read (const char* name, uint32_t* size);
* 函数原型：
```
int32_t* file_read_part (const char* name, const void* buffer, uint32_t size, uint32_t offset);
int32_t file_read_part (const char* name, const void* buffer, uint32_t size, uint32_t offset);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t* | 返回实际读取的字节数。 |
| 返回值 | int32\_t | 返回实际读取的字节数。 |
| name | const char* | 文件名。 |
| buffer | const void* | 数据缓冲区。 |
| size | uint32\_t | 数据长度。 |

10
src/tkc/fs.h
View File

@ -436,19 +436,19 @@ ret_t file_remove(const char* name);
*
* @param {const char*} name 文件名。
*
* @return {ret_t} 返回不是-1表示成功，否则表示失败。
* @return {int32_t} 返回非负表示文件大小，否则表示失败。
*/
int32_t file_get_size(const char* name);
/**
* @method file_read
*
* 读取文件。
* 读取文件的全部内容。
*
* @param {const char*} name 文件名。
* @param {uint32_t*} size 缓冲区大小。
* @param {uint32_t*} size 返回实际读取的长度。
*
* @return {int32_t*} 返回实际读取的字节数。
* @return {void*} 返回读取的数据，需要调用TKMEM_FREE释放。
*/
void* file_read(const char* name, uint32_t* size);
@ -462,7 +462,7 @@ void* file_read(const char* name, uint32_t* size);
* @param {uint32_t} size 数据长度。
* @param {uint32_t} offset 偏移量。
*
* @return {int32_t*} 返回实际读取的字节数。
* @return {int32_t} 返回实际读取的字节数。
*/
int32_t file_read_part(const char* name, void* buff, uint32_t size, uint32_t offset);

14
tools/idl_gen/idl.json
View File

@ -19047,8 +19047,8 @@
"desc": "获取文件大小。\n",
"name": "file_get_size",
"return": {
"type": "ret_t",
"desc": "返回不是-1表示成功，否则表示失败。"
"type": "int32_t",
"desc": "返回非负表示文件大小，否则表示失败。"
}
},
{
@ -19061,15 +19061,15 @@
{
"type": "uint32_t*",
"name": "size",
"desc": "缓冲区大小。"
"desc": "返回实际读取的长度。"
}
],
"annotation": {},
"desc": "读取文件。\n",
"desc": "读取文件的全部内容。\n",
"name": "file_read",
"return": {
"type": "int32_t*",
"desc": "返回实际读取的字节数。"
"type": "void*",
"desc": "返回读取的数据，需要调用TKMEM_FREE释放。"
}
},
{
@ -19099,7 +19099,7 @@
"desc": "从某个位置读取文件。\n",
"name": "file_read_part",
"return": {
"type": "int32_t*",
"type": "int32_t",
"desc": "返回实际读取的字节数。"
}
},