Cogent C API and Utilities : Version 5.4
	Cascade Historian Functions

`HI_Delete`

HI_Delete — removes a history from memory only.

Syntax

#include <cogent.h>
ST_STATUS HI_Delete( IP_hTASK   historian, 
  char*   retbuf, 
  int   buflen, 
  char*   histpattern);

Arguments

historian: The task pointer to the Cascade Historian program.
retbuf: An optional buffer containing an error message.
buflen: 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.
histpattern: A globbing pattern specifying a group of histories.

Returns

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.

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 Cascade Historian delete command and the hist_delete dynamic library function.

`ST_STATUS HI_Delete(`	IP_hTASK	`historian`,
	char*	`retbuf`,
	int	`buflen`,
	char*	`histpattern)`;


HI_Deadband		HI_Describe