op_ima_obj_hname_get()
摘要
生成对象的层次结构名称。
语法
op_ima_obj_hname_get (objid, hname, max_len)
| 参数 | 类型 | 说明 |
|---|---|---|
objid |
Objid |
目标对象的对象 ID |
hname |
char * |
用于存放生成的层次结构名称的字符缓冲区(大小至少为 max_len 个字符) |
max_len |
int |
层次结构名称的最大长度 |
返回类型
Compcode
完成代码,指示操作是否成功完成。发生错误时为 OPC_COMPCODE_FAILURE(参见错误一节);否则为 OPC_COMPCODE_SUCCESS。
示例
char name[100];
if (op_ima_obj_hname_get (op_id_self (), name, 100) == OPC_COMPCODE_SUCCESS)
printf ("This object's name is %s\n", name);
详情
此内核过程获取指定对象的层次结构名称,并在必要时从名称前端舍弃字符,以将名称限制在 max_len 之内。
用途
此内核过程生成指定对象的层次结构名称。名称被放入 hname。与通过反复调用 op_ima_obj_attr_get() 获取对象及其各级父对象的名称相比,op_ima_obj_hname_get() 提供了更快的生成层次结构名称的方式。
错误
- 可恢复错误:对象 ID(
<site_objid>)超出范围。 - 可恢复错误:对象 ID(
<site_objid>)指向一个受限对象。
参考
- 使用内核过程 op_id_from_name() 根据层次结构名称获取对象 ID