Ets_Obj_Client_State_Access()
Note: Requires OPNET Development Kit
Abstract
Returns but does not uninstall the client's state pointer.
Syntax
Ets_Obj_Client_State_Access (obj_hndl, client_ID)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_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
void *
State that you installed on this object via Ets_Obj_Client_State_Set(), or NULL.
Header
ets_pstate.h
Details
This function is like Ets_Obj_Client_State_Get(), except this function will leave the state pointer on the object. The function Ets_Obj_Client_State_Get() uninstalls (removes) the state pointer from the object because the object no longer considers itself the owner of that state. This function, in contrast, will leave the state on the object and the object will continue to retain ownership of that state.
This function is useful if you want to examine the state installed on an object, but you want the state to remain on that object.
If no state was on object, NULL will be returned.