HI_BufferIDLength

Cogent API and Utilities: Version 4.1
Prev |  | Next

# `HI_BufferIDLength`

`HI_BufferIDLength` -- gives the length of an interpolation buffer.

## Syntax

    #include <cogent/cogent.h>

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

## 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.

`length`

  Return value containing the number of values in an interpolation buffer.

## 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 determines the exact number of values in the interpolation buffer identified by `bufferid`, and returns that number in `length`.

This function corresponds to the Cascade Historian bufferIdLength command and two dynamic library functions: `hist_buffer_id_length` and `hist_length_buffer`.

Prev | Home | Next
`HI_BufferIDDestroy` | Up | `HI_BufferIDRead`

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