#include <cogent.h>
ST_STATUS HI_Delete(
IP_hTASK historian, char* retbuf, int buflen, char* histpattern )
;
The task pointer to the Cascade Historian program.
An optional buffer containing an error message.
The length in bytes of retbuf. If retbuf is non-NULL, this must be a valid non-zero length. If retbuf is NULL, this parameter is ignored.
A globbing pattern specifying a group of histories.
ST_OK on success. Otherwise ST_ERROR, and the retbuf will contain a NULL-terminated character string with an error message. If the return value is ST_OK, the retbuf may not contain useful information.
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 Cascade Historian delete command and the hist_delete dynamic library function.
Copyright © 1995-2010 by Cogent Real-Time Systems, Inc. All rights reserved.