Ovis_Entity_Attr_Get_Str()
摘要
从与 Ovis 实体关联的应用对象中获取字符串属性值
语法
Ovis_Entity_Attr_Get_Str (ent_ptr, attr_name, buf_size_ptr, buffer)
| 参数 | 类型 | 说明 |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Ovis 装饰实体 |
attr_name |
const char * |
属性名 |
buf_size_ptr |
size_t * |
缓冲区最大长度(字节) |
buffer |
char * |
用于存放属性值的字符缓冲区 |
返回类型
OvisT_Compcode
若无法获取属性值则返回 OvisC_Compcode_Failure,否则返回成功。如果获取失败是因为缓冲区太小,*buf_size_ptr 将被设置为成功获取所需的最小长度。
头文件
ovis_entity.h
详情
该函数从与 Ovis 实体关联的应用对象中获取字符串属性值。
示例
OvisT_Entity * ent_ptr;
size_t size = 100;
char value [100];
/* Entity was created at some point */
Ovis_Entity_Attr_Get_Str (ent_ptr, "model", &size, value);
错误
- 实体为 NIL
- 属性名无效。
- 长度字段为 NIL。
- 字符串属性值的返回地址为 NIL。
参考
- 使用函数 Ovis_Entity_Attr_Get_Dbl() 获取 double 型属性的值。
- 使用函数 Ovis_Entity_Attr_Get_Int32() 获取整型属性的值。