Ets_Model_Network_State_Access()
Note: Requires OPNET Development Kit
Abstract
Returns the client's state pointer.
Syntax
Ets_Model_Network_State_Access (mdl_hndl, client_ID)
| 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. |
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
Unlike the Ets_Model_Network_State_Get() function, calling this function leaves the client state installed in the model. This function will return NULL if there is no installed client state or if either argument is invalid. Model type must be network.