prg_log_write()
Abstract
Writes an entry directly to a log store.
Syntax
prg_log_write (log_store_hndl, options, …)
| Argument | Type | Description |
|---|---|---|
log_store_hndl |
PrgT_Log_Store_Handle |
Log store of interest. |
options |
int |
Options for writing the log entry (see options). |
… |
various |
Additional columns for the log entry (see …). |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the entry was added successfully; PrgC_Compcode_Failure otherwise.
Header
prg_log.h
Details
This function lets you write an entry directly to a log store without having to obtain a log handle (as required by prg_log_handle_write()).
After assembling the log entry from the data specified by the … argument, this function writes the entry to the log store.
options
The options argument must be either PRGC_LOG_WRITE_OPT_NONE or:
PRGC_LOG_WRITE_OPT_COLUMN_NAME—the … values include column names
…
The variable argument (…) specifies additional column data. Normally, this argument consists of [type, value] pairs for every column defined in the log template. These pairs must appear in the order in which the columns are defined in the template.
If the PRGC_LOG_WRITE_OPT_COLUMN_NAME option is set, the … argument consists of one or more [column title, value type, value] tuples, followed by a null (PRGC_NIL) to terminate the argument string. In this case, only desired columns must be specified.