prg_log_text_export()
Abstract
Dumps the contents of a log to a text file.
Syntax
prg_log_to_text_export (log_store_hndl, path, options)
| Argument | Type | Description |
|---|---|---|
log_store_hndl |
PrgT_Log_Store_Handle |
Log store of interest. |
path |
const char * |
Complete path and file name, including extension, for the text file. |
options |
int |
PRGC_TRUE for a comma-separated file; PRGC_FALSE for a tab-separated file. |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the export is successful; PrgC_Compcode_Failure otherwise.
Header
prg_log.h
Details
The text file created by this function will contain a line of column titles followed one line of column values for each record in the log. Comma-separated files enclose each title or value in double quotes and separate them with commas. Tab-separated files put tabs between the titles or values in each line.
For example, a comma-separated file would have the following format:
"<title_1>","<title_2>", … ,"<title_n>"
"<value_1>","<value_2>", … ,"<value_n>"
…
"<value_1>","<value_2>", … ,"<value_n>"