Ovis_Entity_From_Objhandle_Create()
Abstract
Creates the Ovis entity using the ETS object handle of a site.
Syntax
Ovis_Entity_From_Objhandle_Create (ets_obj_handle, callback, state_ptr)
| Argument | Type | Description |
|---|---|---|
ets_obj_handle |
EtsT_Obj_Handle |
ETS object handle of a site |
callback |
OvisT_Entity_State_Destroy_Proc | Callback function that will destroy the entity’s state when the entity is destroyed |
state_ptr |
void * |
User-defined state associated with the entity |
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 creates an Ovis entity based on the site referenced by the ETS object handle. If an entity is already associated with the specified site, the function returns the existing entity (the existing state and the destroy process are not updated by the provided arguments). This function can only be used in the context of an ETS function call.
Example
OvisT_Entity * ent_ptr;
EtsT_Obj_Handle handle;
/* handle set to some appropriate node or subnet */
ent_ptr = Ovis_Entity_From_Objhandle_Create (handle, OPC_NIL, OPC_NIL);
Errors
- None
Reference
- None