Ets_Model_Network_State_Set()
Note: Requires OPNET Development Kit
Abstract
Deallocates any installed client state by calling state_destroy_proc.
Syntax
Ets_Model_Network_State_Set (mdl_hndl, client_ID, client_state_ptr)
| Argument | Type | Description |
|---|---|---|
mdl_hndl |
EtsT_Model_Handle |
Handle to object with state pointer of interest. |
client_ID |
EtsT_Client_State_ID |
An object can have many different client state types. This identifies your client state type. |
client_state_ptr |
void * |
Pointer to your structure that you want installed. |
Return Type
EtsT_Compcode
A value of EtsC_Compcode_Failure will be returned if an error condition occurs. One common error is to pass an invalid model handle, a model that isn't a network model type, or an invalid client_ID.
Header
ets_pstate.h
Details
Sets the client's state in the scenario. This function will return failure if client_ID or mdl_hndl isn't valid, or if the state being set is the same pointer as the state already installed.
The model type must be network.