Ovis_Entity_State_Set()
Abstract
Sets the state of an Ovis entity.
Syntax
Ovis_Entity_State_Set (ent_ptr, state_ptr)
| Argument | Type | Description |
|---|---|---|
ent_ptr |
OvisT_Entity * |
Specifies the entity |
state_ptr |
void * |
Specifies the entity state |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the entity could be updated; OvisC_Compcode_Failure otherwise.
Header
ovis_entity.h
Details
This function sets the state of the Ovis entity.
Example
OvisT_Entity * entity;
My_Struct_Type * state_ptr;
/* … entity created at some point */
state_ptr = (My_Struct_Type *)op_prg_mem_alloc (sizeof (My_Struct_Type)); // in DES
Ovis_Entity_State_Set (entity, state_ptr);
Errors
- Entity is NIL.
Reference
- Use the function Ovis_Entity_State_Get() to obtain the current state.