Ets_Obj_Attr_Get()
摘要
获取给定 ETS 对象某属性的值。
语法
Ets_Obj_Attr_Get (obj_hndl, attr_name, val_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
目标对象的句柄。 |
attr_name |
char * |
目标属性的名称。 |
val_ptr |
void * |
用于填充属性值的缓冲区。 |
返回类型
EtsT_Compcode
若属性存在且有效则返回 EtsC_Compcode_Success,否则返回 EtsC_Compcode_Failure。
头文件
ets_api_obj.h
详情
获取对象某属性的值。被查询的对象不必已安装到模型中。你可能需要先设置模型属性。val_ptr 指向用于存放返回类型的存储空间。(调用者必须知道属性值的类型。)
| 若返回类型为… | val_ptr 必须是… |
|---|---|
int |
int * |
double |
double * |
string |
char * |
text list |
PrgT_List * |
compound attr obj |
EtsT_Obj_Handle * |
toggle |
int * |
typed file |
char * |
profile |
PrgT_Profile_Spec * |
调用者总是获得所需属性值属于自己的副本,并且总是自行准备存放属性值的存储空间。该函数只能获取上述类型的属性。
成功时,所需属性的值被加载到所提供地址的内存中,并返回成功;否则返回失败。
若使用该函数获取复合属性,它返回的是复合属性的副本。因此:
- 如果你修改了复合属性的副本并希望修改生效,必须把该副本重新设置回它原来的位置。
- 使用完毕后,必须对复合属性的副本调用 Ets_Obj_Destroy()。
要获取复合属性的子属性,请使用处理复合属性中所述的层次名称。