HI_Version

Cogent API and Utilities: Version 4.1
Prev |  | Next

# `HI_Version`

`HI_Version` -- gets the version number of the Cascade Historian.

## Syntax

    #include <cogent/cogent.h>

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

## Arguments

`historian`

  The task pointer to the Cascade Historian program.

`retbuf`

  A required buffer containing an error message.

`buflen`

  The length in bytes of `retbuf`. This must be a valid non-zero length.

## 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 returns the version number of the Cascade Historian in `retbuf`. The `retbuf` and `buflen` parameters are not optional in this case. `buflen` must be at least 32 characters.

This function corresponds to the Cascade Historian version command and the `hist_version` dynamic library function.

Prev | Home | Next
`HI_Unregister` | Up | Inter-Process Communication Functions

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