op_ima_obj_attr_get_str_sized()
摘要
使用带长度的缓冲区获取指定对象中某个 string 类型属性的值。
语法
op_ima_obj_attr_get_str_sized (objid, attr_name, size_ptr, value_buffer)
| 参数 | 类型 | 说明 |
|---|---|---|
objid |
Objid |
关注对象的对象 ID [对象 ID 可以从 Topo 包和 Id 包中的多个内核过程获得: op_id_self()、op_topo_parent()、op_topo_child()、op_id_from_userid() 和 op_id_from_name()。] |
attr_name |
const char * |
关注属性的名称 [该属性必须是指定对象中已定义的 string 类型属性,否则会发生错误。] |
size_ptr |
size_t * |
调用时,指向 value_buffer 大小的指针(包含结尾 '\0' 所占的空间)。返回时, value_buffer 中属性值的实际大小。 |
value_buffer |
char * |
指向某个变量的指针,该变量将被填入指定属性的值(值的最大长度为 size_ptr – 1 个字符) |
返回类型
Compcode
若成功获取属性值,返回 OPC_COMPCODE_SUCCESS;否则返回 OPC_COMPCODE_FAILURE。
示例
{
char tx_nodename [128];
char * buffer_ptr;
size_t size;
Compcode status;
buffer_ptr = tx_nodename;
size = 128;
tx_nodeid = op_id_parent (op_td_get_int (pkptr, OPC_TDA_RA_TX_OBJID));
status = op_ima_obj_attr_get_str_sized (tx_nodeid, "name", &size, tx_nodename);
}
详情
该函数与 op_ima_obj_attr_get_str() 类似,不同之处在于它带有一个 size 参数,并且在返回属性值时不会溢出 value_buffer。对于大于 value_buffer 的字符串属性值,将返回截断后的字符串。
用途
提供一种在仿真过程中动态获取对象属性的机制。该内核过程与 op_ima_obj_attr_get() 的工作方式完全相同,但仅适用于数据类型为 string 的对象属性。完整用途与详情参见 op_ima_obj_attr_get()。
错误
- 与 op_ima_obj_attr_get() 相同,外加以下内容:
- 程序中止:属性(
<name>)的类型为(<type>)。无法以 string 类型获取其值。
参考
- 使用内核过程 op_ima_obj_attr_set()、op_ima_obj_attr_set_dbl()、op_ima_obj_attr_set_int32()、op_ima_obj_attr_set_objid()、op_ima_obj_attr_set_str() 和 op_ima_obj_attr_set_toggle() 为对象属性赋值
- 使用内核过程 op_ima_obj_attr_get_str() 获取类型为 string 的对象属性的值(无需指定缓冲区大小)
- 使用内核过程 op_ima_obj_attr_get_dbl() 获取类型为 double 的对象属性的值
- 使用内核过程 op_ima_obj_attr_get_int32() 获取类型为 integer 的对象属性的值
- 使用内核过程 op_ima_obj_attr_get_objid() 获取类型为 objid 的对象属性的值
- 使用内核过程 op_ima_obj_attr_get_toggle() 获取类型为 toggle 的对象属性的值
- 使用内核过程 op_ima_sim_attr_get()、op_ima_sim_attr_get_dbl()、op_ima_sim_attr_get_int32() 和 op_ima_sim_attr_get_str() 获取仿真属性的值
- 使用内核过程 op_ima_obj_svar_get() 获取进程状态变量的值
- 使用内核过程 op_ima_obj_command() 向对象发出命令
- 使用内核过程 op_id_self() 获取所在处理器或队列的对象 ID
- 使用内核过程 op_id_from_name() 获取任意对象的对象 ID