awtk/docs/manual/tk_ostream_mem_t.md
2023-12-26 19:09:36 +08:00

56 lines
1.6 KiB
Markdown

## tk\_ostream\_mem\_t
### 概述
![image](images/tk_ostream_mem_t_0.png)
基于内存实现的输出流。
----------------------------------
### 函数
<p id="tk_ostream_mem_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#tk_ostream_mem_t_tk_ostream_mem_create">tk\_ostream\_mem\_create</a> | 创建ostream对象。 |
| <a href="#tk_ostream_mem_t_tk_ostream_mem_create_simple">tk\_ostream\_mem\_create\_simple</a> | 创建ostream对象。 |
#### tk\_ostream\_mem\_create 函数
-----------------------
* 函数功能:
> <p id="tk_ostream_mem_t_tk_ostream_mem_create">创建ostream对象。
* 函数原型:
```
tk_ostream_t* tk_ostream_mem_create (void* buff, uint32_t size, uint32_t packet_size, bool_t own_the_buff);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | tk\_ostream\_t* | 返回ostream对象。 |
| buff | void* | 返回数据的缓冲区。 |
| size | uint32\_t | 缓冲区的大小。 |
| packet\_size | uint32\_t | 缺省一次写入的数据的长度(一般无0)。 |
| own\_the\_buff | bool\_t | 是否让ostream对象拥有buff。 |
#### tk\_ostream\_mem\_create\_simple 函数
-----------------------
* 函数功能:
> <p id="tk_ostream_mem_t_tk_ostream_mem_create_simple">创建ostream对象。
* 函数原型:
```
tk_ostream_t* tk_ostream_mem_create_simple (void* buff, uint32_t size);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | tk\_ostream\_t* | 返回ostream对象。 |
| buff | void* | 返回数据的缓冲区。 |
| size | uint32\_t | 缓冲区的大小。 |