prg_log_open()
摘要
打开一个日志并将其初始化为可读或可写。
语法
prg_log_open (log_name, log_directory, options, status_ptr)
| 参数 | 类型 | 说明 |
|---|---|---|
log_name |
const char * |
日志名称(不含路径或扩展名)。 |
log_directory |
const char * |
包含该日志的目录的完整路径,或空字符串(可选;参见详情)。 |
options |
int |
打开操作的选项(参见 options)。 |
status_ptr |
PrgT_Log_Store_Status * |
用于存放打开操作结果的区域;取值为表 2 中列出的符号值之一。 |
返回类型
PrgT_Log_Store_Handle
新打开的日志;操作失败时返回 PRGC_NIL。
头文件
prg_log.h
详情
如果该日志是 tfile,则只需 log_name 参数即可在默认 tfile 目录中定位并打开该日志。如果该日志不是 tfile,可以使用 log_directory 参数指定包含该日志的目录(即包含 <log name>.olf.dir 目录的那个目录)。
options
options 参数必须是 PRGC_LOG_OPEN_OPT_NONE,或者是所需选项按位或(OR)的组合:
PRGC_LOG_OPEN_OPT_READ——以读取方式打开日志;如果日志文件不存在则返回空值PRGC_LOG_OPEN_OPT_WRITE——以写入方式打开日志并删除所有已有行PRGC_LOG_OPEN_OPT_APPEND——以写入方式打开日志并保留所有已有行PRGC_LOG_OPEN_OPT_HIDE_DATE——不在日志模板中添加默认日期列PRGC_LOG_OPEN_OPT_INCLUDE_SEVERITY——将事件严重性作为模板的第二列(位于日期之后);设置此选项时,写入日志的所有行都必须包含严重性(使用表 2 中列出的PrgT_Log_Severity_Type值)PRGC_LOG_OPEN_OPT_NO_PROGRESS_BAR——打开时不显示进度条