Ets_Obj_Client_State_Set()
注意: 需要 OPNET Development Kit
摘要
通过调用 state_destroy_proc 释放对象上已安装的 client state,并在对象上设置 client 的 state。
语法
Ets_Obj_Client_State_Set (obj_hndl, client_ID, client_state_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
你希望存储 state 的对象的句柄 |
client_ID |
EtsT_Client_State_ID |
一个对象可以拥有多种不同的 client state 类型。此参数用于标识你的 client state 类型。 |
client_state_ptr |
void * |
指向你希望安装的结构体的指针。 |
返回类型
EtsT_Compcode
若 client state 安装成功则返回 EtsC_Compcode_Success,否则返回 EtsC_Compcode_Failure。
头文件
ets_pstate.h
详情
此函数将 client state 指针安装到指定对象上。此函数遵循的模式与在仿真数据包中获取和设置结构体字段所使用的模式类似。调用 Ets_Obj_Client_State_Set() 会将 client state 设置进对象。此时对象即为该内存的所有者。若对象被删除,它会释放该 client state。调用 Ets_Obj_Client_State_Get() 会将 client state 从对象上移除。
只有链路、子网和节点支持 client state。其他 ETS 对象类型(如 annotation、复合属性对象和子对象)不支持 Ets_Obj_Client_State_Set()。
client state 一旦安装,当对象被复制时该 state 会被复制,当模型被写入时该 state 会被写入,当对象被删除时该 state 会被释放。