Ovis_Group_State_Set()
Abstract
Sets the client state for an Ovis group.
Syntax
Ovis_Group_State_Set (group_ptr, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
group_ptr |
OvisT_Group * |
Ovis group |
user_state_ptr |
void * |
Specifies the optional user-provided state of the group |
Return Type
void *
Previous state of the group
Header
ovis_entity.h
Details
This function sets the client state of the Ovis group.
Example
OvisT_Group * group;
void * old_state;
/* …group created elsewhere */
old_state = Ovis_Group_State_Set (group, OPC_NIL);
Errors
- Group is NIL.
Reference
- Use the function
Ovis_Group_Destroy_Proc_Set()to specify a function to be invoked when the group is destroyed. - Use the function
Ovis_Group_State_Get()to retrieve the current client state of a group.