HistorianAccess Class Members
- Last UpdatedAug 21, 2026
- 5 minute read
The following tables list the members exposed by HistorianAccess.
| Name | Description | |
|---|---|---|
 | HistorianAccess Constructor | The HistorianAccess constructor initalizes the HistorianAccess object. |
| Name | Description | |
|---|---|---|
 | AddStreamedValue | Overloaded. Use the AddStreamedValue() method to add streamed event data. |
| AddTag | Use the AddTag() method to add tag information to the server or local cache. |
| AddTagExtendedProperties | Use the AddTagExtendedProperties() method to add tag extended properties to the server or local cache. |
| AddTagLocalizedProperties | Use the AddTagLocalizedProperties() method to add tag localized properties to the server or local cache. |
| CloseConnection | Use the CloseConnection method to close a connection to the server. |
| CloseStorageConnection | Use the CloseStorageConnection() method to flush all memory buffers that contain store-and-forward snapshots to storage so that HCAL can start forwarding the snapshots to the Historian. After this call, all storage-related functions, such as the AddTag() method or AddStreamValues() method, will not be allowed and will return an error. Retrieval functions, including status checkings, are still valid. |
| CreateAnalogSummaryQuery | Use the CreateAnalogSummaryQuery() method to retrieve the tag values from the AnalogSummary table. |
| CreateEventQuery | Use the CreateEventQuery() method to retrieve events. |
| CreateHistorianDataValueList | Use the CreateHistorianDataValueList() method to build a data value list based on the category of data specified by the category parameter. |
| CreateHistoryQuery | Use the CreateHistoryQuery() method to retrieve the tag values from the History table. |
| CreateStateSummaryQuery | Use the CreateStateSummaryQuery() method to retrieve the tag values from the StateSummary table. |
| CreateTagQuery | Use the CreateTagQuery() method to retrieve tag list. |
| DeleteTagExtendedPropertiesByName | Use the DeleteTagExtendedPropertyGroup() method to delete the extended properties of a tag. |
| DeleteTagLocalizedPropertiesByName | Use the DeleteTagLocalizedPropertyGroup() method to delete the localized properties of a tag. |
| DeleteTags | Use the DeleteTags() method to delete tags from the server. |
| Dispose | Overloaded. The HistorianAccess destructor method. |
| ExecuteSqlCommand | Use the ExecuteSqlCommand() method to run the SQL command on the database. |
| GetConnectionStatus | Use the GetConnectionStatus() to get the client status with respect to the Historian Server. |
| GetHistorianConsole | Use GetHistorianConsole method to get the HistorianConsole instance. |
| GetHistorianInfo | The GetHistorianInfo() method gets the Historian information from the Historian Server. |
| GetRuntimeParameter | |
| GetStoreForwardStatus | Use the GetStoreForwardStatus() method to get the status of the store-and-forward engine. |
| GetSystemTimeZoneInfo | The GetSystemTimeZoneInfo() method gets the time zone information based on the current time zone name from the Historian Server. |
| GetTagExtendedPropertiesByName | The GetTagExtendedPropertiesByName() method gets all the tag properties and its extended properties from the cache or Historian Server using tagname as a parameter. |
| GetTagExtendedPropertyGroupStatusByName | Use the GetTagExtendedPropertyGroupStatusByName() method to check the current status of tag extended properties of a tag. |
| GetTagInfoByName | The GetTagInfoByName() method gets all the tag properties from the cache or Historian Server using tagname as a parameter. |
| GetTagLocalizedPropertiesByName | The GetTagLocalizedPropertiesByName() method gets all the tag properties and its localized properties from the cache or Historian Server using tagname as a parameter. |
| GetTagLocalizedPropertyGroupStatusByName | Use the GetTagLocalizedPropertyGroupStatusByName() method to check the current status of tag localized properties of a tag. |
| GetTagRenameStatus | Use the GetTagRenameStatus() method to check the current status of tag rename operation. |
| GetTagStatusByName | Use the GetTagStatusByName() method to check the current status of tag. |
| LogMessage | Use the LogMessage() method to log client messages to the ArchestrA Logger. |
| OpenConnection | Use the OpenConnection() method to create an asynchronous connection to the Historian Server. |
| RenameTags | |
| SendValues | Use the SendValues() method to perform a data value insert, a single point update, or a multi-point update. |
| TestConnection | Use the TestConnection() method to test if connection can be made to the Historian Server. |
