hist_delete

hist_delete — removes a history from memory only.

Syntax

hist_delete (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 all memory associated with a given history, but does not remove any files on disk. It flushes the history to disk.

This function corresponds to the delete command, and the Cogent C API function HI_Delete.

Example

Gamma> hist_delete (tsk, "p6");
t
Gamma> hist_delete (tsk, "p6");
nil
Gamma> _last_error_;
"No history for point p6"