Ovis_Group_Entity_Remove()
Abstract
Removes an entity from an Ovis group.
Syntax
Ovis_Group_Entity_Remove (group_ptr, ent_ptr)
| Argument | Type | Description |
|---|---|---|
group_ptr |
OvisT_Group * |
Ovis group |
ent_ptr |
OvisT_Entity * |
Ovis entity |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the entity can be removed from the group; OvisC_Compcode_Failure otherwise.
Header
ovis_entity.h
Details
This function removes an entity from a group.
Example
OvisT_Group * group;
OvisT_Entity * entity;
/* group and entity created elsewhere */
Ovis_Group_Entity_Remove (group, entity);
Errors
- Group is NIL.
- Entity is NIL.
Reference
- Use the function
Ovis_Group_Entity_Add()to add an entity to a group. - Use the function
Ovis_Group_Child_Entity_Count()to obtain the number of child entities. - Use the function
Ovis_Group_Child_Entity_Nth()to retrieve a child entity of a group.