awtk/docs/manual/object_array_t.md

object_array_t

概述

简单的动态数组，内部存放value对象。

访问时属性名称为：

• "size"/"length" 用于获取数组的长度。
• index 用于访问属性，-1可以用来追加新元素。

---

函数

函数名称	说明
object_array_clear_props	清除全部属性。
object_array_clone	克隆对象。
object_array_create	创建对象。
object_array_get	获取指定序数的元素。
object_array_insert	在指定位置插入一个元素。
object_array_pop	弹出一个元素。
object_array_push	追加一个元素。
object_array_remove	在指定位置删除一个元素。
object_array_set	设置指定序数的元素。
object_array_unref	for script gc

属性

属性名称	类型	说明
capacity	uint32_t	属性数组的容量。
props	value_t	属性数组。
size	uint32_t	属性个数。

object_array_clear_props 函数

---

• 函数功能：

清除全部属性。

• 函数原型：

ret_t object_array_clear_props (object_t* obj);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	对象。

object_array_clone 函数

---

• 函数功能：

克隆对象。

• 函数原型：

object_t* object_array_clone (object_array_t* o);

• 参数说明：

参数	类型	说明
返回值	object_t*	返回object对象。
o	object_array_t*	被克隆的对象。

object_array_create 函数

---

• 函数功能：

创建对象。

• 函数原型：

object_t* object_array_create ();

• 参数说明：

参数	类型	说明
返回值	object_t*	返回object对象。

object_array_get 函数

---

• 函数功能：

获取指定序数的元素。

• 函数原型：

ret_t object_array_get (object_t* obj, uint32_t i, value_t* v);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	数组对象。
i	uint32_t	序数。
v	value_t*	返回的元素。

object_array_insert 函数

---

• 函数功能：

在指定位置插入一个元素。

• 函数原型：

ret_t object_array_insert (object_t* obj, uint32_t index, const value_t* v);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	对象。
index	uint32_t	位置。
v	const value_t*	值。

object_array_pop 函数

---

• 函数功能：

弹出一个元素。

• 函数原型：

ret_t object_array_pop (object_t* obj, value_t* v);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	对象。
v	value_t*	返回值。

object_array_push 函数

---

• 函数功能：

追加一个元素。

• 函数原型：

ret_t object_array_push (object_t* obj, const value_t* v);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	对象。
v	const value_t*	值。

object_array_remove 函数

---

• 函数功能：

在指定位置删除一个元素。

• 函数原型：

ret_t object_array_remove (object_t* obj, uint32_t index);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	对象。
index	uint32_t	位置。

object_array_set 函数

---

• 函数功能：

设置指定序数的元素。

• 函数原型：

ret_t object_array_set (object_t* obj, uint32_t i, const value_t* v);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	数组对象。
i	uint32_t	序数。
v	const value_t*	元素。

object_array_unref 函数

---

• 函数功能：

for script gc

• 函数原型：

ret_t object_array_unref (object_t* obj);

• 参数说明：

参数	类型	说明
返回值	ret_t	返回RET_OK表示成功，否则表示失败。
obj	object_t*	对象。

capacity 属性

---

属性数组的容量。

• 类型：uint32_t

特性	是否支持
可直接读取	是
可直接修改	否

props 属性

---

属性数组。

• 类型：value_t

特性	是否支持
可直接读取	是
可直接修改	否

size 属性

---

属性个数。

• 类型：uint32_t

特性	是否支持
可直接读取	是
可直接修改	否
可脚本化	是