Ovis_Entity_From_Objhandle_Get()
Abstract
Retrieves the Ovis entity using the object handle of a site.
Syntax
Ovis_Entity_From_Objhandle_Get (ets_handle, options)
| Argument | Type | Description |
|---|---|---|
ets_handle |
EtsT_Obj_Handle |
ETS object handle of a site |
options |
int |
Specifies options |
Return Type
OvisT_Entity *
Returns the Ovis entity, or OVISC_NIL.
Header
ovis_entity.h
Details
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 have an associated entity. The search stops at the first ancestor with an entity.
Example
OvisT_Entity * ent_ptr;
EtsT_Obj_Handle handle;
/* handle set to some appropriate node or subnet */
ent_ptr = Ovis_Entity_From_Objhandle_Get (handle, OVISC_ENTITY_FROM_SITE_ONLY);
Errors
- None
Reference
- None