awtk/docs/manual/object_wbuffer_t.md
2023-06-29 10:44:29 +08:00

88 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## object\_wbuffer\_t
### 概述
![image](images/object_wbuffer_t_0.png)
将wbuffer包装成object。
----------------------------------
### 函数
<p id="object_wbuffer_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#object_wbuffer_t_object_wbuffer_cast">object\_wbuffer\_cast</a> | 转换为object_wbuffer对象。 |
| <a href="#object_wbuffer_t_object_wbuffer_create">object\_wbuffer\_create</a> | 创建wbuffer对象。 |
| <a href="#object_wbuffer_t_object_wbuffer_create_extendable">object\_wbuffer\_create\_extendable</a> | 创建可扩展的wbuffer对象。 |
### 属性
<p id="object_wbuffer_t_properties">
| 属性名称 | 类型 | 说明 |
| -------- | ----- | ------------ |
| <a href="#object_wbuffer_t_wbuffer">wbuffer</a> | wbuffer\_t* | wbuffer对象。 |
#### object\_wbuffer\_cast 函数
-----------------------
* 函数功能:
> <p id="object_wbuffer_t_object_wbuffer_cast">转换为object_wbuffer对象。
* 函数原型:
```
object_wbuffer_t* object_wbuffer_cast (tk_object_t* obj);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | object\_wbuffer\_t* | object\_wbuffer对象。 |
| obj | tk\_object\_t* | object\_wbuffer对象。 |
#### object\_wbuffer\_create 函数
-----------------------
* 函数功能:
> <p id="object_wbuffer_t_object_wbuffer_create">创建wbuffer对象。
* 函数原型:
```
tk_object_t* object_wbuffer_create (uint8_t* data, uint32_t capacity);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | tk\_object\_t* | 返回object对象。 |
| data | uint8\_t* | 缓冲区。 |
| capacity | uint32\_t | 缓冲区的容量。 |
#### object\_wbuffer\_create\_extendable 函数
-----------------------
* 函数功能:
> <p id="object_wbuffer_t_object_wbuffer_create_extendable">创建可扩展的wbuffer对象。
* 函数原型:
```
tk_object_t* object_wbuffer_create_extendable ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | tk\_object\_t* | 返回object对象。 |
#### wbuffer 属性
-----------------------
> <p id="object_wbuffer_t_wbuffer">wbuffer对象。
* 类型wbuffer\_t*
| 特性 | 是否支持 |
| -------- | ----- |
| 可直接读取 | 是 |
| 可直接修改 | 否 |