prg_log_max_log_rows_set()
Abstract
Sets the maximum number of rows that a log will maintain.
Syntax
prg_log_max_log_rows_set (log_store_hndl, max_log_rows)
| Argument | Type | Description |
|---|---|---|
log_store_hndl |
PrgT_Log_Store_Handle |
Log store of interest. |
max_log_rows |
int |
Maximum number of rows per log, or PRGC_LOG_SIZE_NO_LIMIT. |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if set successfully; PrgC_Compcode_Failure otherwise.
Header
prg_log.h
Details
A log can be set to maintain a maximum number of rows (entries). This is done by implementing the log as a rolling buffer, in which the last max_log_rows rows comprise the log. Any earlier rows are unavailable for display in the log viewer (although they might still exist in older data (.ot) files, if unmaintained data files are being preserved). By default, a log will maintain 5000 rows.
If max_log_rows is set to PRGC_LOG_SIZE_NO_LIMIT, there is no limit on the number of rows that will be maintained. This is not recommended for logs that are opened with PRGC_LOG_OPEN_OPT_APPEND, because the log can grow very large and might overwhelm available storage space.