test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-12-04 21:17:50 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
20bdc1668a
awtk/docs/manual/data_writer_t.md

138 lines
3.7 KiB
Markdown
Raw Normal View History

update docs
2020-03-17 10:48:59 +08:00
## data\_writer\_t
### 概述
数据写入接口。
update docs
2021-01-11 08:23:05 +08:00
>对可写的媒介，如内存、文件、flash和其它媒介提供一个统一的写入接口。
update docs
2020-03-17 10:48:59 +08:00
----------------------------------
### 函数
<p id="data_writer_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
update docs
2021-02-23 11:17:36 +08:00
| <a href="#data_writer_t_data_writer_clear">data\_writer\_clear</a> | 清除指定URL的数据。 |
update docs
2020-03-17 10:48:59 +08:00
| <a href="#data_writer_t_data_writer_destroy">data\_writer\_destroy</a> | 销毁writer对象。 |
update docs
2021-05-11 15:53:22 +08:00
| <a href="#data_writer_t_data_writer_flush">data\_writer\_flush</a> | flush数据。 |
update docs
2021-02-23 11:17:36 +08:00
| <a href="#data_writer_t_data_writer_truncate">data\_writer\_truncate</a> | 截去指定长度之后的数据。 |
update docs
2020-03-17 10:48:59 +08:00
| <a href="#data_writer_t_data_writer_write">data\_writer\_write</a> | 在指定位置写入数据。 |
update docs
2022-04-22 18:59:41 +08:00
| <a href="#data_writer_t_data_writer_write_all">data\_writer\_write\_all</a> | 写入全部数据。 |
update docs
2021-02-23 11:17:36 +08:00
#### data\_writer\_clear 函数
-----------------------
* 函数功能：
> <p id="data_writer_t_data_writer_clear">清除指定URL的数据。
* 函数原型：
```
ret_t data_writer_clear (const char* url);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| url | const char* | URL。 |
update docs
2020-03-17 10:48:59 +08:00
#### data\_writer\_destroy 函数
-----------------------
* 函数功能：
> <p id="data_writer_t_data_writer_destroy">销毁writer对象。
* 函数原型：
```
ret_t data_writer_destroy (data_writer_t* writer);
```
* 参数说明：
update docs
2021-05-11 15:53:22 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| writer | data\_writer\_t* | writer对象。 |
#### data\_writer\_flush 函数
-----------------------
* 函数功能：
> <p id="data_writer_t_data_writer_flush">flush数据。
* 函数原型：
```
ret_t data_writer_flush (data_writer_t* writer);
```
* 参数说明：
update docs
2020-03-17 10:48:59 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| writer | data\_writer\_t* | writer对象。 |
update docs
2021-02-23 11:17:36 +08:00
#### data\_writer\_truncate 函数
-----------------------
* 函数功能：
> <p id="data_writer_t_data_writer_truncate">截去指定长度之后的数据。
* 函数原型：
```
ret_t data_writer_truncate (data_writer_t* writer, uint64_t size);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| writer | data\_writer\_t* | writer对象。 |
| size | uint64\_t | 保留长度。 |
update docs
2020-03-17 10:48:59 +08:00
#### data\_writer\_write 函数
-----------------------
* 函数功能：
> <p id="data_writer_t_data_writer_write">在指定位置写入数据。
* 函数原型：
```
int32_t data_writer_write (data_writer_t* writer, uint64_t offset, const void* data, uint32_t size);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回实际读取数据的长度。 |
| writer | data\_writer\_t* | writer对象。 |
| offset | uint64\_t | 偏移量。 |
| data | const void* | 数据缓冲区。 |
| size | uint32\_t | 数据长度。 |
update docs
2022-04-22 18:59:41 +08:00
#### data\_writer\_write\_all 函数
-----------------------
* 函数功能：
> <p id="data_writer_t_data_writer_write_all">写入全部数据。
* 函数原型：
```
int32_t data_writer_write_all (const char* url, const void* data, uint32_t size);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | int32\_t | 返回实际写入数据的长度。 |
| url | const char* | URL。 |
| data | const void* | 数据缓冲区。 |
| size | uint32\_t | 数据长度。 |
Reference in New Issue Copy Permalink