stTabular History Automation API's

The following API functions are available for use with the stTabular History Automation Interface:

 

API method:

Description:

AddItemViaAliasName

Adds an item to the application via its Alias Name.

AddItemWithDisplayName

Adds an item to the application with a name to use for Display purposes.

ConfigSetCache

Switch between reading OPC DA items from the device or cache

ConnectToCollector

Instructs the control to connect to the named Sapphire Collector.

ConnectToOPCDA

Instructs the control to connect to the named Data Access (DA) OPC Server.

ConnectToOPCHDA

Instructs the control to connect to the named Historical Data Access (HDA) OPC Server.

Disconnect

Causes the control to disconnect from the current Data Source.

EnableItemDropDown

Enable or disable the item list control.

EnableToolTips

Enable or disable the display tool-tips.

GetItemColor

Gets the color assigned to the given pen.

GetItemHandle

Get the handle for a given Item.

GetSDRs

Returns the list of SDRs held by the data collector the control is connected to.

GetSelectedItem

Gets the name of the OPC item that is currently selected.

GetSelectedItemHandle

Gets the pen handle for the currently selected item.

GetVersionString

Returns version information about the control.

IsValidItem

Ensure that the pen identified by the handle is valid.

LoadTabHistFile

Load a stTabular History file.

RemoveAllItems

Remove all the current Items from control.

RemoveItem

Remove an Item using its handle.

SetMinuteListLength

Sets the amount of data to be displayed in the 1 minute snapshot window.

SelectItem

Select the Item identified by its handle