EtsT_Client_State_Xml_Export_Proc
Note: Requires OPNET Development Kit
Abstract
Callback: Called when the client state needs to be exported to an XML file.
Syntax
<xml_export_proc_name> (state_ptr, xml_node_ptr)
| Argument | Type | Description |
|---|---|---|
state_ptr |
void * |
The client state to be exported. |
xml_node_ptr |
struct _xmlNode * |
A childless XML node. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the client state is successfully serialized; EtsC_Compcode_Failure otherwise.
Header
ets_pstate.h
Details
When an object with an installed client state is exported to XML, the corresponding xml_export_proc (registered by Ets_Client_State_Handlers_Register_Xml()) is called. This callback should translate the data in the client state to XML form by using the Ets_State_Xml_ write functions to add children to the node (this operation is referred to as serialization). All data serialized into the XML node will be exported. If the callback returns failure, none of the state block will be written to disk.