Ovis_Group_Destroy()
Abstract
Destroys an Ovis group and deallocates the memory of the group.
Syntax
Ovis_Group_Destroy (group_ptr)
| Argument | Type | Description |
|---|---|---|
group_ptr |
OvisT_Group * |
Group to be destroyed |
Return Type
void
No return value.
Header
ovis_entity.h
Details
This function destroys an Ovis group and deallocates the memory of the group. Destroying a group will destroy all associated child groups that are only associated with this group.
The destroy_proc function associated with the group is called if it was specified when the group was created or with Ovis_Group_Destroy_Proc_Set().
Example
OvisT_LGroup * group;
/* Group was created at some point */
Ovis_Group_Destroy (group);
Errors
- Group is NIL.
Reference
- Use the function
Ovis_Group_Destroy_Proc_Set()to specify a function to be invoked when a group is destroyed.