op_id_from_userid()
摘要
获取按父对象、对象类型和用户 ID 指定的对象的对象 ID。
语法
op_id_from_userid (parent_objid, obj_type, userid)
| 参数 | 类型 | 说明 |
|---|---|---|
parent_objid |
int |
目标对象的父对象的对象 ID 对于子网、节点、链路或 tap 对象,其父对象始终是子网对象。 |
obj_type |
int |
目标对象的类型 该值是标识目标对象类型的数字代码(参见表 69 “Object Type Symbolic Constants“ 第 19 页)。该内核过程的对象类型仅限于网络域对象。该参数可接受的符号常量为: OPC_OBJTYPE_SUBNET_FIXOPC_OBJTYPE_NODE_FIXOPC_OBJTYPE_NODE_MOBOPC_OBJTYPE_NODE_SATOPC_OBJTYPE_LKSIMPOPC_OBJTYPE_LKDUPOPC_OBJTYPE_LKBUSOPC_OBJTYPE_LKTAP |
userid |
int |
目标对象的用户 ID 该值是用户定义的整数,与网络域对象的 user id 属性进行比较。 |
返回类型
Objid
指定对象的对象 ID。
若发生可恢复错误,将返回符号常量 OPC_OBJID_INVALID 所代表的特殊值。
示例
/* determine local node object ID */
local_objid = op_topo_parent (op_id_self ());
/* obtain the site number from attribute */
op_ima_obj_attr_get (local_objid, "site no", &site_no);
/* obtain the object IDs of four neighbor nodes */
objid_north = op_id_from_userid (0, OPC_OBJTYPE_NODE_FIX, site_no + DIR_NORTH);
objid_south = op_id_from_userid (0, OPC_OBJTYPE_NODE_FIX, site_no + DIR_SOUTH);
objid_east = op_id_from_userid (0, OPC_OBJTYPE_NODE_FIX, site_no + DIR_EAST);
objid_west = op_id_from_userid (0, OPC_OBJTYPE_NODE_FIX, site_no + DIR_WEST);
详情
该内核过程通过三个参数指定目标对象:其父对象的对象 ID、其类型及其用户 ID(分配给网络域对象 user id 属性的用户定义整数)。该内核过程设计用于同一父对象内同类型对象的用户 ID 不重复的情形。若这一条件不成立(例如同一子网内的两个节点具有相同的用户 ID),则返回哪个匹配对象是不确定的,但不会发生错误。
用途
提供一种将对象用户 ID 映射为对象 ID 的机制。该内核过程的典型应用是使用数字标识符(而非内核过程 op_id_from_name() 所使用的名称标识符)获取节点的对象 ID。若为用户 ID 精心分配使其唯一且连续,则可将它们用作扫描某一特定类型全部对象的循环索引。
错误
- 可恢复错误:对象 ID(
<parent_objid>)超出范围。 - 可恢复错误:对象(
<parent_objid>)没有子对象。 - 可恢复错误:对象类型(
<obj_type>)超出范围。 - 可恢复错误:对象(
<parent_objid>)没有指定类型且用户 ID 为(<userid>)的子对象。 - 可恢复错误:对象 ID(
<objid>)指向受限对象。
参考
- 使用内核过程 op_id_from_name() 根据名称获取对象的对象 ID
- 使用内核过程 op_ima_obj_attr_get() 获取对象属性的值
- 使用内核过程 op_ima_obj_attr_set() 为对象属性赋值