Cascade Historian: Version 4.1
Prev |  | Next

# flush

flush -- writes buffered data to disk.

## Syntax

    (flush [pattern])

## Arguments

`pattern`

  The name of one or more (using a globbing pattern) histories previously defined by the history command. When this parameter is not specified, the default is `*`, to include all histories.

## Returns

`t` (true) if successful, otherwise

        (error "No history matching pattern")

## Description

This command removes the data for the specified history or histories from the buffer and writes them to the associated files. If no `pattern` is specified, all buffers are flushed to file.

This command corresponds to the Cogent API function `HI_Flush` and the `hist_flush` dynamic library function.

## Example

        [sh]$ lsend Hist
        Hist> (flush p3)
        t
        Hist> (flush p*)
        t
        Hist> (flush)
        t
        Hist>

Prev | Home | Next
filebase | Up | histdb

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