op_hla_interaction_pk_struct_get()
注意: 需要 High-Level Architecture 功能
摘要
从数据包字段名中提取一个数据块。
语法
op_hla_interaction_pk_struct_get (pk_ptr, field_name, data_ptr, size_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
pk_ptr |
Packet * |
代表传入交互的数据包 |
field_name |
const char * |
将从中检索数据的字段名 |
data_ptr |
char * * |
指向用于接收来自字段的数据块的变量的指针 |
size_ptr |
size_t * |
指向用于接收数据块大小(字节数)的变量的指针 |
返回类型
Compcode
完成代码,指示数据获取的成功或失败。如果数据已成功检索,该内核过程返回 OPC_COMPCODE_SUCCESS;如果无法检索数据,则返回 OPC_COMPCODE_FAILURE。
示例
pk = op_pk_get (REQUEST_STRM);
op_pk_nfd_get (pk, "number ids", &num_ids);
if (num_ids != 0)
{
int data_size;
int * data;
int i;
op_hla_interaction_pk_struct_get (pk, "ids", &data, &data_size);
for (i = 0; i < num_ids; i++)
{
if (data [i] == my_id)
{
. . .
详情
RTI 交互的字段要么是简单类型(short、long、double),要么是一块任意数据,需要由交互的发送方编码、接收方解释。由于数据的实际大小事先未知,该内核过程会分配一块合适大小的内存(其地址通过 data_ptr 返回,其大小写入 size_ptr)。内核过程的调用者负责使用 op_prg_mem_free() 释放所分配的内存块。
用途
提供了一种机制,用于获取从代表交互的数据包中提取的通用数据块。
错误
- 可恢复错误:无法获取交互数据包的字段(
<field_name>)。
参考
- 使用内核过程 op_hla_interaction_pk_deregister() 停止接收传入交互的通知
- 使用内核过程 op_hla_interaction_pk_register() 接收传入交互的通知
- 使用内核过程 op_prg_mem_free() 释放通过
data_ptr返回的内存块