prg_log_close()
Abstract
Closes a log store.
Syntax
prg_log_close (log_store_hndl, options)
| Argument | Type | Description |
|---|---|---|
log_store_hndl |
PrgT_Log_Store_Handle |
Log store to close. |
options |
int |
Options for closing the log store (see options). |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the log store is closed successfully; PrgC_Compcode_Failure otherwise.
Header
prg_log.h
Details
This function closes the specified log store and frees its memory. Old log files (those with old entries that exceed the maximum number of entries for the log) are deleted unless the PRGC_LOG_CLOSE_OPT_KEEP_OLD_FILES option was specified.
If the log is being displayed in a live log viewer when this function is called, the log is closed. The viewer remains open, but no further entries are sent to it.
options
The options argument must be either PRGC_LOG_CLOSE_OPT_NONE or an OR’ed combination of the desired options:
PRGC_LOG_CLOSE_OPT_KEEP_OLD_FILES—do not delete OT files containing old entriesPRGC_LOG_CLOSE_OPT_EXPORT_TO_XML—write the entire log to an XML file before closing (the XML file is saved in the same directory as the.olf.dirdirectory)