Ovis_Entity_From_Objid_Get()

Abstract

Retrieves the Ovis entity using the object ID of a site.

Syntax

Ovis_Entity_From_Objid_Get (des_objid, options)
Argument Type Description
des_objid Objid Object ID
options int Specifies options (see Details)

Return Type

OvisT_Entity *

Returns the entity, or OVISC_NIL.

ovis_entity.h

Details

This function uses the ID of the simulated object to retrieve the associated Ovis entity.

If options is OVISC_ENTITY_FROM_SITE_ONLY, this function uses the site's object handle to retrieve the Ovis entity associated with the site. The function returns OVISC_NIL if no entity exists for that site.

If options is OVISC_ENTITY_FROM_SITE_OR_PARENTS, this function will also look at parent subnets to see if any has an associated entity. The search stops at the first ancestor with an entity.

Example

OvisT_Entity   * ent_ptr;

/* Look for entity associated with node containing that process model */

ent_ptr = Ovis_Entity_From_Objid_Get (op_topo_parent (op_id_self ()),
	OVISC_ENTITY_FROM_SITE_ONLY);

Errors

  • Object ID (<id>) is out-of-range.
  • Object ID (<id>) refers to a restricted object.
  • Object <hname> is not a fixed or mobile node or subnet.

Reference

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com