Ovis_Entity_From_Hname_Get()
Abstract
Retrieves the Ovis entity based on the full hierarchical name of a site.
Syntax
Ovis_Entity_From_Hname_Get (hname)
| Argument | Type | Description |
|---|---|---|
hname |
const char * |
Full hierarchical name of the site. |
Return Type
OvisT_Entity *
Returns the entity or OVISC_NIL if the function failed to return an entity.
Header
ovis_entity.h
Details
This function will take in the full hierarchical name of an object and return the Ovis entity, if any, associated with this site. If the hierarchical name does not correspond to a site (node or subnet) or the site is not associated with an entity, the function returns OVISC_NIL.
Example
OvisT_Entity * ent_ptr;
/* Entity was created at some point */
ent_ptr Ovis_Entity_From_Hname_Get ("top.subnet.chopper");
Errors
- Invalid hierarchical name argument provided.
- No object matches provided hierarchical name (
<name>). - Object (
<name>) is no a fixed or mobile node or subnet.
Reference
- None