op_anim_macro_destroy()
摘要
移除指定的宏,释放其内存,并移除通过调用该宏创建的所有保留绘图。
语法
op_anim_macro_destroy (anmid)
| 参数 | 类型 | 说明 |
|---|---|---|
anmid |
Anmid |
宏 ID [动画宏 ID 可在通过 KP op_anim_macro_create() 创建宏时获得。] |
返回类型
void
无返回值
示例
/* Determine interrupt type. */
itype = op_intrpt_type ();
/* Check for node failure interrupt. */
if (itype = OPC_INTRPT_FAIL)
{
/* Node is dead; close associated animation viewer and macro’s. */
op_anim_viewer_close (local_vid);
op_anim_macro_destroy (local_move_mid);
op_anim_macro_destroy (local_comm_mid);
}
详情
被销毁宏创建的保留绘图会从查看器的保留绘图列表中移除,但它们在屏幕上的显示不会被显式擦除(可以通过发出查看器重绘请求使其消失)。
用途
提供了一种销毁现有宏的机制。这很少是必要的,因为宏通常数量不多、资源占用小,并且可由多个查看器共享。不过,如果要定义大量一次性宏,可能需要使用本 KP 强制宏的生灭循环。
错误
- 可恢复错误:Animation macro ID (
<anmid>) is [out-of-range | unrecognized].(前者由于anmid参数值无效;后者由于宏已被销毁)
参考
- 使用 KP op_anim_macro_close() 完成宏定义,禁止再添加请求
- 使用 KP op_anim_viewer_close() 关闭查看器(这不会影响在该查看器中显示的宏定义)