HI_Count

Cogent API and Utilities: Version 4.1
Prev |  | Next

# `HI_Count`

`HI_Count` -- counts the number of histories that match a pattern.

## Syntax

    #include <cogent/cogent.h>

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

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

`count`

  Return value containing the number 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 queries the Cascade Historian for the total number of histories currently being kept that match the given pattern.

This function corresponds to the Cascade Historian count command and the `hist_count` dynamic library function.

Prev | Home | Next
`HI_ClipBuffer` | Up | `HI_Deadband`

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