Ovis_Entity_Objid_Get()
Abstract
Retrieves the object ID.
Syntax
Ovis_Entity_Objid_Get (ent_ptr)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Entity |
Return Type
Objid
Returns the object ID.
Header
ovis_entity.h
Details
This function retrieves the object ID for the Ovis entity. It can only be used in the context of a simulation.
Example
OvisT_Entity * entity;
Objid objid;
/* … entity created at some point */
objid = Ovis_Entity_Objid_Get (entity);
Errors
- Entity is NIL.
Reference
- Use the function
Ovis_Entity_Objhandle_Get()to perform the same action in the context of an ETS library.