op_ici_format_print_proc_set()
摘要
为指定格式的 ICI 中命名结构字段设置自定义打印过程。
语法
op_ici_format_print_proc_set (format_name, field_name, print_proc)
| 参数 | 类型 | 说明 |
|---|---|---|
format_name |
const char * |
目标 ICI 格式的名称。 |
field_name |
const char * |
目标字段的名称。 [该名称必须是 ICI 格式中已定义的结构字段。] |
print_proc |
Ici_Struct_Print_Meth |
用户自定义的打印过程,当打印具有指定格式和字段的 ICI 时会被调用。函数原型见「详情」小节。 |
返回类型
Compcode
完成代码,指示打印过程是否设置成功。如果发生本内核过程「错误」小节中列出的任何可恢复错误,将返回 OPC_COMPCODE_FAILURE。
示例
/* Install a print procedure for the "address" field of all ICIs */
/* with the "ip_info" packet format. */
/* address_print_proc is defined in the function block as follows: */
/* */
/* void address_print_proc (void *structure_ptr, PrgT_List *dest_lptr) */
/* { */
/* char *char_line; */
/* ReqT_Address *addr_ptr; */
/* */
/* addr_ptr = (ReqT_Address *) structure_ptr; */
/* char_line = op_prg_mem_alloc (sizeof (char) * 60); */
/* sprintf (char_line, "subnet: %d", addr_ptr->subnet); */
/* op_prg_list_insert (dest_lptr, char_line, OPC_LISTPOS_TAIL); */
/* char_line = op_prg_mem_alloc (sizeof (char) * 60); */
/* sprintf (char_line, "node : %s", addr_ptr->node_name); */
/* op_prg_list_insert (dest_lptr, char_line, OPC_LISTPOS_TAIL); */
/* } */
op_ici_format_print_proc_set ("ip_info", "address", address_print_proc);
详情
使用该内核过程可以指定一个函数,用于为存储在结构类型 ICI 字段内的数据结构创建文本表示。这类数据结构可能相当复杂,因此文本表示对调试很有用处。
当打印 ICI 时(在 ODB 中使用 iciprint_ev 或 iciprint_pk,或使用 op_ici_print()),仿真内核会调用指定的 print_proc,以获得 ICI 中该结构字段的文本表示。
print_proc 必须具有以下原型:
typedef void
(*Ici_Struct_Print_Meth) (void *structure_ptr, PrgT_List *dest_lptr);
print_proc 必须向 *dest_lptr 添加新条目。结构字段的内容通过 *structure_ptr 传入。使用 prg_mem_alloc() 为要添加到链表中的字符串分配内存。仿真内核会自动释放全部内存。
用途
将 print_proc 设置为当指定字段(field_name)在任意具有指定格式(format_name)的 ICI 中被打印时要调用的函数。field_name 必须标识一个结构字段。
使你能够指定当在 ODB 中使用 iciprint_ev 或 iciprint_pk,或使用 op_ici_print() 内核过程时,仿真内核未知的结构将如何显示。
错误
- 可恢复错误:字段
<field name>不是结构字段 - 可恢复错误:ICI 格式(
<format_name>)无法识别。 - 可恢复错误:属性名称(
<field_name>)在格式为(<format_name>)的 ICI 中无法识别。
参考
- 使用内核过程 op_ici_print() 将 ICI 的内容打印到标准输出设备