The Cascade Historian

Cogent API and Utilities: Version 4.1
Prev |  | Next

# Chapter 6. The Cascade Historian

The Cogent API for the Cascade Historian consists of C functions that are wrappers around the Cascade Historian command set. The C syntax for these functions is documented in the Cascade Historian Functions reference section of this manual, while the command syntax is documented in the Cascade Historian manual. Please refer to that document for general information on the Cascade Historian.

# 6.1. Command/Function Correspondence

The following table shows all the commands and functions available in the Cascade Historian and the corresponding Cogent API functions, illustrating how they correspond to each other. This table is also available in the Command/Function Correspondence section of the Cascade Historian manual.

Table 6-1. Cascade Historian Commands and Functions

Command | API Function | DLL Function
--- | --- | ---
add | `HI_Add` | -
apropos | - | -
aproposSyntax | - | -
bufferIdData | `HI_BufferIDRead` | `hist_buffer_id_read`
bufferIdDataAscii | - | -
bufferIdDestroy | `HI_BufferIDDestroy` | `hist_buffer_id_destroy`
bufferIdLength | `HI_BufferIDLength` | `hist_buffer_id_length`
bufsize | `HI_Bufsize` | `hist_bufsize`
count | `HI_Count` | `hist_count`
deadband | `HI_Deadband` | `hist_deadband`
delete | `HI_Delete` | `hist_delete`
describe | `HI_Describe` | `hist_describe`
disable | `HI_Disable` | `hist_disable`
earliest | `HI_Earliest` | `hist_earliest`
enable | `HI_Enable` | `hist_enable`
exit | - | -
flag | - | -
filebase | `HI_FileBase` | `hist_filebase`
flush | `HI_Flush` | `hist_flush`
histdb | - | -
history | `HI_History` | `hist_history`
include | - | -
interpolate | `HI_Interpolate` | `hist_interpolate`
- | `HI_InterpolateData` | `hist_interpolate_data`
interpolatorDescribe | - | -
interpolatorList | - | -
latest | `HI_Latest` | `hist_latest`
length | `HI_Length` | `hist_length`
list | `HI_List` | `hist_list`
register | `HI_Register` | `hist_register`
unregister | `HI_Unregister` | `hist_unregister`
version | `HI_Version` | `hist_version`

Prev | Home | Next
Parsing Point Messages | Up | Binary Data Buffer Functions

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