HistorianGetInfo

(Engine-Level Function)

Description: Retrieves information about a specified Historian or all Historians.
Returns: Varies depending on the request.
Usage: Script Only.
Threaded: No.
Related to: HistorianConnect | HistorianDeleteRecords | HistorianGetData | HistorianReadRecords | HistorianWriteRecords
Format: HistorianGetInfo(ConnectionHandle, InfoType)
Parameters:  
ConnectionHandle
As returned by an HistorianConnect call.
InfoType
A numeric expression specifying the type of information to be returned, as follows:

InfoType

Information requested

0

Counters. A dictionary of dictionaries of dictionaries containing full counter information for all sequences stored by this Historian.

1

Errors. A dictionary of write or deletion errors that occurred in this Historian since the last time GetInfo(Historian, 1) was called.

2

Overall write queue count. The number of records in the write queue for all Historians (ConnectionHandle parameter is ignored).

3

Overall records stored. A rollover count of the records stored by all Historians (ConnectionHandle parameter is ignored). This counter rolls over (2^32) and therefore is only useful for performance diagnostics. It is not a count of all records in storage.

4

Write queue count. The number of records in the write queue for this Historian.

5

Records stored. A rollover count of the records stored by this Historian. This counter rolls over and therefore is only useful for performance diagnostics. It is not a count of all records in storage.

6

Overall write queue size. The approximate memory size of the write queue for all Historians (ConnectionHandle parameter is ignored).

Example:

No example provided. This function is not recommended for most use.