op_ev_state()
Abstract
Gets the event state associated with an event at the time of event creation.
Syntax
op_ev_state (evhandle)
| Argument | Type | Description |
|---|---|---|
evhandle |
Evhandle |
event handle that identifies the event [An event handle can be obtained from several KPs in this package, such as op_ev_current(), op_ev_seek_time(), and op_ev_next().]. |
Return Type
void*
Event state associated with the event.
Example
/* on the receiver end */
My_Model_Data * data_ptr = op_ev_state (evhandle);
process_and_destroy_model_data (data_ptr);
Details
Because the Simulation Kernel does not know anything about the content of an event state, you must be sure to get the event state with the appropriate data type.
Purpose
This function returns the event state (installed with op_ev_state_install()) that was current at the time the specified event was generated.
Errors
- Recoverable Error: Event handle refers to an event that is either invalid or not currently scheduled.
Reference
- Use the KP op_ev_state_install() to install an event state to be associated with events