HI_Enable

Cogent API and Utilities: Version 4.1
Prev |  | Next

# `HI_Enable`

`HI_Enable` -- activates data recording.

## Syntax

    #include <cogent/cogent.h>

``ST_STATUS HI_Enable`(IP_hTASK historian, char* retbuf, int buflen, char* histpattern);`

## Arguments

`historian`

  The task pointer to the Cascade Historian program.

`retbuf`

  An optional buffer containing an error message.

`buflen`

  The length in bytes of `retbuf`. If `retbuf` is non-NULL, this must be a valid non-zero length. If `retbuf` is NULL, this parameter is ignored.

`histpattern`

  A globbing pattern specifying a group of histories.

## Returns

`ST_OK` on success. Otherwise `ST_ERROR`, and the `retbuf` will contain a NULL-terminated character string with an error message. If the return value is `ST_OK`, the `retbuf` may not contain useful information.

## 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 Cascade Historian enable command and the `hist_enable` dynamic library function.

Prev | Home | Next
`HI_Earliest` | Up | `HI_ExchangeBuffer`

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