prg_log_column_add()
摘要
向日志添加一个新列。
语法
prg_log_column_add (log_store_hndl, title, format_string, value_type)
| 参数 | 类型 | 说明 |
|---|---|---|
log_store_hndl |
PrgT_Log_Store_Handle |
目标日志存储(必须处于可写状态且不包含任何数据)。 |
title |
const char * |
要添加的列的名称(必须唯一)。 |
format_string |
const char * |
可选的类 printf 字符串,用于格式化列值的显示(见详情)。不使用时为 PRGC_NIL。 |
value_type |
PrgT_Log_Value_Type |
列值的数据类型;表 2 所列常量中的一种。 |
返回类型
PrgT_Compcode
如果列成功添加,返回 PrgC_Compcode_Success;否则返回 PrgC_Compcode_Failure。
头文件
prg_log.h
详情
使用该函数来定义日志模板。日志打开时,最初包含一个日期列(索引 0);如果在对 prg_log_open() 的调用中设置了 PRGC_LOG_OPEN_OPT_INCLUDE_SEVERITY 选项,则还包含一个严重级别列(索引 1)。该函数将指定列添加到模板的末尾(右侧),即下一个可用的索引处。写入时,必须按照定义各列时的相同顺序传递各列的值。
format_string 的语法为
%['][<flag>]*[<int_width>][.<precision>]df
其中
'表示为数字添加千位分隔符(仅 Linux)<flag>是以下内容的任意组合:'+':以 + 或 - 号显示数字' ':用空格填充小数部分'0':用零填充小数部分<int_width>是整数部分的最小宽度<precision>是小数位数
该格式的前后可以带有附加文本。如果 format_string 以 ^<、^> 或 ^| 开头,列值将分别左对齐、右对齐或居中。
例如,格式字符串 %'+03.4d 会将数字 1.3 和 -1300.123345 显示为 ' +1.3000' 和 '-1,300.1233'(在 Linux 上,使用国际英语区域设置)。