EtsT_Client_State_Write_Proc
Note: Requires OPNET Development Kit
Abstract
Callback: Called when the client state needs to be written to disk with the scenario data.
Syntax
<state_write_proc_name> (state_ptr, block_hndl)
| Argument | Type | Description |
|---|---|---|
state_ptr |
void * |
The client state of the object being written to disk. |
block_hndl |
EtsT_State_Block_Handle |
An empty state block. |
Return Type
EtsC_Block_Ignore if there is no state information to be written to disk; EtsC_Block_Good otherwise.
Header
ets_pstate.h
Details
When an object with an installed client state is written to disk, the corresponding state_write_proc (registered by Ets_Client_State_Handlers_Register()) is called. This callback should write all needed information into the empty state block (using the Ets_State_Block_ write functions). Everything placed into the block will be saved to disk.