Cogent C API and Utilities : Version 5.4
	Cascade Historian Functions

`HI_BufferIDDestroy`

HI_BufferIDDestroy — destroys an interpolation buffer.

Syntax

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

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.
bufferid: The buffer identifier, as created by a call to HI_Interpolate.

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 destroys the temporary internal buffer associated with an interpolation request. The memory allocated by an interpolation request can be very large, and will persist until it is explicitly destroyed.

This function corresponds to the Cascade Historian bufferIdDestroy command and the hist_buffer_id_destroy dynamic library function.

`ST_STATUS HI_BufferIDDestroy(`	IP_hTASK	`historian`,
	char*	`retbuf`,
	int	`buflen`,
	int	`bufferid)`;


HI_Add		HI_BufferIDLength