hist_buffer_id_destroy

Cascade Historian: Version 4.1
Prev |  | Next

# `hist_buffer_id_destroy`

`hist_buffer_id_destroy` -- destroys an interpolation query buffer.

## Syntax

    hist_buffer_id_destroy(hist_task, queryid)

## Parameters

`hist_task`

  The task object corresponding to the Cascade Historian. A task object is created by a call to the Gamma function `locate_task`, as follows:

          hist_task = locate_task ("tfrc/histdb", nil);

`queryid`

  The reference number for the result of a query made on the Cascade Historian using the `hist_interpolate` function or the interpolate command.

## Returns

t (true) if the transformation was performed with no errors, otherwise nil.

## 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 bufferIdDestroy command and the Cogent API function `HI_BufferIDDestroy`.

## See also

hist_interpolate

Prev | Home | Next
`hist_buffer2array` | Up | `hist_buffer_id_length`

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.