prg_log_close()
摘要
关闭一个日志存储。
语法
prg_log_close (log_store_hndl, options)
| 参数 | 类型 | 说明 |
|---|---|---|
log_store_hndl |
PrgT_Log_Store_Handle |
要关闭的日志存储。 |
options |
int |
关闭日志存储的选项(见 options)。 |
返回类型
PrgT_Compcode
如果日志存储成功关闭,返回 PrgC_Compcode_Success;否则返回 PrgC_Compcode_Failure。
头文件
prg_log.h
详情
该函数关闭指定的日志存储并释放其内存。除非指定了 PRGC_LOG_CLOSE_OPT_KEEP_OLD_FILES 选项,否则老日志文件(其中包含超出该日志条目数上限的老条目的文件)将被删除。
如果调用该函数时该日志正在实时日志查看器中显示,则该日志会被关闭。查看器保持打开状态,但不再向其发送后续条目。
options
options 参数必须是 PRGC_LOG_CLOSE_OPT_NONE,或者由所需选项按位或(OR)组合而成的值:
PRGC_LOG_CLOSE_OPT_KEEP_OLD_FILES——不删除包含老条目的 OT 文件PRGC_LOG_CLOSE_OPT_EXPORT_TO_XML——在关闭之前将整个日志写入一个 XML 文件(该 XML 文件保存在与.olf.dir目录相同的目录中)