op_ima_obj_attr_set_color()
摘要
为指定对象中的颜色属性赋值。
语法
op_ima_obj_attr_set_color (objid, attr_name, value)
| 参数 | 类型 | 说明 |
|---|---|---|
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* |
目标属性的名称 [该值必须是指定对象的已定义属性。] |
value |
PrgT_Color |
指定属性的新值 |
返回类型
Compcode
若属性值设置成功,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
示例
/* Update the link's color. */
PrgT_Color new_color = prg_color_from_string ("red");
op_ima_obj_attr_set_color (link_objid, "color", new_color);
详情
如果找不到该属性,此内核过程不会报告错误;你必须检查返回值才能发现这一点。由于不报告错误,此内核过程免除了事先使用 op_ima_obj_attr_exists() 以防止产生警告的需要。
用途
提供一种在仿真进行过程中动态赋值对象属性的机制。此内核过程的工作方式与 op_ima_obj_attr_set() 完全相同,但仅适用于数据类型为 PrgT_Color 的对象属性。完整的用途与详情参见 op_ima_obj_attr_set()。
错误
- 与 op_ima_obj_attr_set() 相同。
参考
- 使用内核过程 op_ima_obj_attr_get_color() 或 op_ima_obj_attr_get() 获取对象颜色属性的值
- 使用内核过程 op_ima_sim_attr_get_color() 或 op_ima_sim_attr_get() 获取仿真颜色属性的值
- 使用内核过程 op_id_self() 获取所在处理器或队列的对象 ID
- 使用内核过程 op_id_from_name() 获取任意对象的对象 ID