Cascade Historian: Version 4.1
Prev |  | Next

# unregister

unregister -- unregister histories with the Cascade DataHub.

## Syntax

    (unregister pattern)

## Parameters

`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 causes the Cascade Historian to unregister each history matching the pattern from the Cascade DataHub. The history will cease to receive exceptions when the point value data changes. If multiple histories are associated with the same point, registering or unregistering one of the histories will do the same to all the other histories sharing the same point.

If the history is not currently registered with the Cascade DataHub, this command does nothing.

This command corresponds to the Cogent API function `HI_Unregister` and the `hist_unregister` dynamic library function.

## Example

        (unregister p3)
        (unregister p*)

Prev | Home | Next
register | Up | version

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