hist_disable

Cascade Historian: Version 4.1
Prev |  | Next

# `hist_disable`

`hist_disable` -- stops data recording.

## Syntax

    hist_disable (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 flushes one or more histories to disk and causes each of them to ignore all subsequent values until either enable, `hist_enable`, or `HI_Enable` is called on it.

This function corresponds to the disable command, and the Cogent API function `HI_Disable`.

Prev | Home | Next
`hist_describe` | Up | `hist_earliest`

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