hist_enable

Cascade Historian: Version 4.1
Prev |  | Next

# `hist_enable`

`hist_enable` -- activates data recording.

## Syntax

    hist_enable (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

`t` (true) if successful. Otherwise returns `nil` and sets `_last_error_` to the error string returned by the Cascade Historian.

## Description

This function reverses the effect of a previous disable, `hist_disable`, or `HI_Disable` call, so that new data values will be accepted and logged.

This function corresponds to the enable command, and the Cogent API function `HI_Enable`.

Prev | Home | Next
`hist_earliest` | Up | `hist_exchange_buffer`

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