Ovis_Entity_Destroy()
Abstract
Destroys the Ovis entity.
Syntax
Ovis_Entity_Destroy (ent_ptr)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Entity |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the destruction was performed; OvisC_Compcode_Failure otherwise.
Header
ovis_entity.h
Details
This function destroys the Ovis entity and deallocates the memory of that object.
Example
OvisT_Entity * ent_ptr;
/* Entity was created at some point */
Ovis_Entity_Destroy (ent_ptr);
Errors
- Entity is NIL.
Reference
- Use the function Ovis_Entity_Destroy_Proc_Set() to specify a function to be invoked when the entity is destroyed.