Cogent C API and Utilities : Version 6.4
	Cascade Historian Functions

`HI_Disable`

HI_Disable — stops data recording.

Syntax

#include <cogent.h>
ST_STATUS HI_Disable( 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 flushes one or more histories to disk and causes each of them to ignore all subsequent values until either enable, hist_enable, or HI_Enable is called on it.

This function corresponds to the Cascade Historian disable command and the hist_disable dynamic library function.

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


HI_Describe		HI_Earliest