hist_flush
hist_flush — writes buffered data to disk.
Syntax
hist_flush (hist_task[, pattern])
Parameters
- hist_task
The task object corresponding to the
Cascade Historian. See locate_task
in the Gamma manual.
- pattern
The name of one or more (using a globbing pattern)
histories to be acted upon. When this parameter is not
specified, the default is *, to
include all histories.
Returns
t (true) if successful.
Otherwise returns nil and sets
_last_error_ to the error string returned by
the Cascade Historian.
Description
This function removes the data for the
specified history or histories from the buffer and writes them
to the associated files. If no pattern
is specified, all buffers are flushed to file.
This function corresponds to the flush command, and
the Cogent C API function HI_Flush.