Ovis_Layer_State_Set()
Abstract
Sets the client state for an Ovis layer.
Syntax
Ovis_Layer_State_Set (layer_ptr, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
layer_ptr |
OvisT_Layer * |
Ovis layer |
user_state_ptr |
void * |
Specifies the optional user-provided state of the layer |
Return Type
void *
Previous state of the layer
Header
ovis_layer.h
Details
This function sets the client state of the Ovis layer.
Example
OvisT_Layer * layer;
void * old_state;
/* …layer created elsewhere */
old_state = Ovis_Layer_State_Set (layer, OPC_NIL);
Errors
- Layer is NIL.
Reference
- Use the function Ovis_Layer_Destroy_Proc_Set() to specify a function to be invoked when the layer is destroyed.
- Use the function Ovis_Layer_State_Get() to retrieve the current client state of a layer.