hist_length_buffer

Cascade Historian: Version 4.1
Prev |  | Next

# `hist_length_buffer`

`hist_length_buffer` -- returns the number of `X`-`Y` pairs.

## Syntax

    hist_length_buffer (buffer)

## Parameters

`buffer`

  A binary buffer of `X`-`Y` pairs of doubles, as created by a call to `hist_buffer_id_read`.

## Returns

The number of `X`-`Y` data pairs, an integer-valued number.

## Description

This function returns the number of `X`-`Y` pairs in a buffer previously obtained by the `hist_buffer_id_read` function. This function is similar to the `hist_buffer_id_length` function, but saves an unnecessary exchange with the Cascade Historian when the data has already been retrieved once.

This function corresponds in part to the bufferIdLength command and the Cogent API function `HI_BufferIDLength`.

## Example

        count = hist_length_buffer(buf);

Prev | Home | Next
`hist_length` | Up | `hist_list`

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