Ovis_Group_Destroy_Proc_Set()
Abstract
Attaches a destroy procedure to an Ovis group.
Syntax
Ovis_Group_Destroy_Proc_Set (group_ptr, destroy_proc)
| Argument | Type | Description |
|---|---|---|
group_ptr |
OvisT_Group * |
Ovis group to which to attach the destroy procedure. |
destroy_proc |
OvisT_Group_State_Destroy_Proc |
Destroy procedure to attach. |
Return Type
OvisT_Group_State_Destroy_Proc
Previous destroy_proc, or PRGC_NIL if none.
Header
ovis_entity.h
Details
This function attaches a user-defined destroy_proc to an Ovis group. The prototype for destroy_proc is given in OvisT_Group_State_Destroy_Proc.
Example
static void new_destroy_proc (OvisT_Group * group, void * user_state_ptr)
{
…
}
OvisT_Group * group;
OvisT_Group_State_Destroy_Proc old_proc;
/* … group created at some point */
old_proc = Ovis_Group_Destroy_Proc_Set (group, new_destroy_proc);
Errors
- Group is NIL.
Reference
- Use the function
Ovis_Group_State_Set()to specify the group user state. - Use the function
Ovis_Group_Destroy()to destroy a group.