op_ima_obj_attr_get_color()
摘要
获取指定对象中某个颜色属性的值。
语法
op_ima_obj_attr_get_color (objid, attr_name, color_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
objid |
Objid |
关注对象的对象 ID [对象 ID 可以从 Topo 包和 Id 包中的多个内核过程获得: op_id_self()、op_topo_parent()、op_topo_child()、op_id_from_userid() 和 op_id_from_name()。] |
attr_name |
const char * |
关注属性的名称 [该属性必须是类型为 color 的属性,并且在指定对象中已定义,否则会发生错误。] |
color_ptr |
PrgT_Color * |
指向某个变量的指针,该变量将被填入指定属性的值 |
返回类型
Compcode
若成功获取属性值,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
示例
PrgT_Color color;
/* get the link color */
op_ima_obj_attr_get_color (link_objid, "color", &color);
详情
无。
用途
提供一种在仿真过程中动态获取对象属性的机制。该内核过程的工作方式与 op_ima_obj_attr_get() 完全相同,但仅适用于数据类型为 PrgT_Color 的对象属性。完整的用途和详情参见 op_ima_obj_attr_get()。
错误
- 与 op_ima_obj_attr_get() 相同,另加以下错误:
- 程序中止:属性(
<attr_name>)的类型为(<type>),无法以类型(color)获取其值。
参考
- 使用内核过程 op_ima_obj_attr_set_color() 或 op_ima_obj_attr_set() 为对象颜色属性赋值
- 使用内核过程 op_ima_sim_attr_get_color() 或 op_ima_sim_attr_get() 获取仿真颜色属性的值
- 使用内核过程 op_id_self() 获取所在处理器或队列的对象 ID
- 使用内核过程 op_id_from_name() 获取任意对象的对象 ID