prg_log_handle_write()

摘要

使用指定的日志句柄向日志存储写入一条记录。

语法

prg_log_handle_write (log_hndl, options, …)
参数 类型 说明
log_hndl PrgT_Log_Handle 待添加记录的日志句柄。
options int 写入日志记录的选项(参见 options)。
… various 日志记录的附加列(参见 …)。

返回类型

PrgT_Compcode

记录成功添加时返回 PrgC_Compcode_Success(因超出事件计数上限而被忽略时也如此);否则返回 PrgC_Compcode_Failure。

头文件

prg_log.h

详情

此函数使用 prg_log_handle_generate() 返回的日志句柄,向该句柄关联的日志存储添加一条记录。记录各列的数据来自两个来源:

  • 生成日志句柄时定义的列和值
  • 由本函数的可变参数 (…) 指定的任何附加列和值

在从这些来源组装出日志记录后,本函数会增加该日志句柄的事件计数。如果尚未超出事件计数上限(或者设置了 PRGC_LOG_WRITE_OPT_IGNORE_LIMIT 选项),本函数会将该记录写入日志存储。

options

options 参数必须是 PRGC_LOG_WRITE_OPT_NONE,或者是所需选项按位或(OR)的组合:

  • PRGC_LOG_WRITE_OPT_COLUMN_NAME——… 值中包含列名
  • PRGC_LOG_WRITE_OPT_IGNORE_LIMIT——即使该日志句柄的事件计数上限已被超出,也仍然添加该记录

…

可变参数 (…) 指定附加的列数据。该参数由针对每个未在日志句柄中定义的列的 [type, value] 成对值组成。这些成对值必须按照列在日志模板中定义的顺序出现。

如果设置了 PRGC_LOG_WRITE_OPT_COLUMN_NAME 选项,则 … 参数由一个或多个 [column title, value type, value] 三元组组成,其后跟一个空值(PRGC_NIL)以终止参数串。在这种情况下,只需指定所需的列。

若要将记录直接写入日志存储(指定所有列值),请使用 prg_log_write()。

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com