hist_count

Cascade Historian: Version 4.1
Prev |  | Next

# `hist_count`

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

## Syntax

    hist_count (hist_task[, pattern])

## Parameters

`hist_task`

  The task object corresponding to the Cascade Historian. See `locate_task` in the Gamma manual.

`pattern`

  The name of one or more (using a globbing pattern) histories to be acted upon. When this parameter is not specified, the default is `*`, to include all histories.

## Returns

The number of histories that match the `pattern`. Otherwise returns `nil` and sets `_last_error_` to the error string returned by the Cascade Historian.

## 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 count command, and the Cogent API function `HI_Count`.

Prev | Home | Next
`hist_clip_buffer` | Up | `hist_deadband`

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