Historian User API Overview

Important: You do not have the latest version of Historian! You are missing out on the newest capabilities and enhanced security. For information on all the latest features, see the Historian product page. For more information on upgrades, contact your GE Digital sales agent or e-mail GE Digital Sales Support. For the most up-to-date documentation, go here.

About the Historian User API

The Historian User API provides high-speed read/write access to Historian data and read access to Historian tags. There is no access to archives, alarms, events, or messages.

Use this API to develop applications that read and write data to the Historian server when the Historian SDK and Historian OLE DB do not meet your project requirements for performance or programming language.

Note: At this time, the Historian User API supports single-byte strings only.

Sample programs are provided with the API that demonstrate how to perform common tasks. Additional information can be found in comments in the sample code and API header.

No guidance is given regarding application conversion from other products or APIs, including converting from the Historian SDK.

To use this API, you must be familiar with the Historian features and functionality. Refer to the Historian electronic books for product information. This is especially important if you are using security groups with Historian, since the applications that call into the User API are limited by the security access granted at the server level.

Prerequisites

You must run the programs you create with the Historian User API on a machine with the following software installed and configured:

  • Historian 5.5 or greater
  • Historian 5.5 or greater Client Tools

The Historian User API has been tested with Visual Studio .NET 2003, 2005, and 2008.

The Historian User API has no additional hardware requirements.

Historian allows you to develop both 32-bit and 64-bit User API programs.

Note: To build a 32-bit User API program on a 64-bit operating system, you must rename ihuapi32.lib to ihuapi.lib and include it in your program.