Ets_Obj_Client_State_Get()
注意: 需要 OPNET Development Kit
摘要
返回先前设置到 ETS 对象上的 client 内存的指针。
语法
Ets_Obj_Client_State_Get (obj_hndl, client_ID)
| 参数 | 类型 | 说明 |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
拥有感兴趣的 state 指针的对象的句柄。 |
client_ID |
EtsT_Client_State_ID |
一个对象可以拥有多种不同的 client state 类型。此参数用于标识你的 client state 类型。 |
返回类型
void *
你通过 Ets_Obj_Client_State_Set() 安装到该对象上的 state,或 NULL。
头文件
ets_pstate.h
详情
此函数将返回安装在指定对象上的 client state 指针。此函数会移除(即卸载)state 指针,因为对象不再认为自己是该 state 的所有者。相比之下,函数 Ets_Obj_Client_State_Access() 会将 state 留在对象上,对象将继续保有该 state 的所有权。
当你想获取安装在对象上的 state 并希望将该 state 从对象上移除时,此函数会很有用。
此函数遵循的模式与在仿真数据包中获取和设置结构体字段所使用的模式类似。调用 Ets_Obj_Client_State_Set() 会将 client state 设置进对象。此时对象即为该内存的所有者。若对象被删除,它会释放该 client state。调用 Ets_Obj_Client_State_Get() 会将 client state 从对象上移除。
若对象上没有安装 client state,将返回 NULL。