Property Reference S-T | Historian 8.1 Documentation

S

SamplingDirectionList Property (Data Object)

This function returns a list of the available Sampling directions for a data request.

Syntax

object.SamplingDirectionList

Parameters

None

SamplingInterval Property (DataCriteria Object)

Returns or sets the interval (in milliseconds) between samples from the archive in the DataRecordset query. For the "RawByNumber" and "RawByTime" sampling modes, the SamplingInterval is ignored. This property can be used in place of the NumberofSamples property.

Syntax

object.SamplingInterval[=Long]

Parameters

None

SamplingIntervalSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SamplingIntervalSet[=Boolean]

Parameters

None

SamplingMode Property (DataCriteria Object)

Returns or sets the mode of sampling data from the archive by the DataRecordset query.

The following table details the available sampling modes:

Name	Description	Value
CurrentValue	Retrieves the current value, the time frame criteria are ignored.	1
Interpolated	Retrieves evenly spaced interpolated values based on NumberOfSamples and the time frame criteria.	2
Trend	Retrieves the raw minimum and raw maximum value for each specified interval. Use the Trend sampling mode to maximize performance when retrieving data points for plotting. A start time, end time, and an interval or number of samples must be specified.	3
RawByTime	Retrieves raw archive values (compressed) based on time frame criteria.	4
RawByNumber	Retrieves raw archive values (compressed) based on the StartTime criteria, the NumberOfSamples, and Direction criteria. Note the EndTime criteria is ignored for this Sampling mode.	5
Calculated	Retrieves evenly spaced calculated values based on NumberOfSamples, the time frame criteria, and the CalculationMode criteria.	6
Lab	The Lab sampling mode only returns the collected values, without any interpolation of the value. The collected value is repeated for each interval until there is a change in the raw data sample's value. Lab sampling is most often used to create a step chart rather than a smooth curve. Use Lab sampling instead of interpolated if you only want true collected values returned. The Lab sampling mode is generally not useful on highly compressed data. Use interpolated sampling instead.	7
InterpolatedtoRaw	When you request interpolated data, you specify an interval or number of samples. If the actual stored number of raw samples is greater than required, you will get interpolated data as described above. If the actual number of stored samples are less than the required, then you will get the raw samples. In this way, the needs of trending detail and application load are balanced. This mode is best used when querying compressed data because the Data Archiver can switch to the more efficient raw data query.	8
TrendtoRaw	TrendtoRaw retrieves raw data between a given intervals when the actual data samples are fewer than the requested number of samples.	9
LabtoRaw	LabtoRaw is an extension to Lab mode of sampling and similar to InterpolatedtoRaw mode where you will be switched to raw data or lab when the actual data samples are fewer than the requested samples.	10
RawByFilterToggle	RawByFilterToggle returns filtered time ranges. The values returned are 0 and 1. If the value is 1, then the condition is true and 0 means false. This sampling mode is used with the time range and filter tag condition. The result starts with a starting time stamp and ends with an ending timestamp.	11

Syntax

object.SamplingMode[=iHistorian_SDK.ihSamplingMode]

Parameters

None

SamplingModeList Property (Data Object)

This function returns a list of the available Sampling Modes for Data.

Syntax

object.SamplingModeList([ExcludeRaw])

Parameters

Name	Data Type	Description
ExcludeRaw	Boolean	Whether to exclude raw sampling modes (optional, default = False).

SamplingModeSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SamplingModeSet[ = Boolean]

Parameters

None

SecondaryUsername Property (DataComments Object)

Returns the user who signed the comment when it was added to the archive.

Syntax

object.SecondaryUsername

Parameters

None

Remarks

SecondaryUserName is a read-only property of type String.

Example

  Debug.Print "Comment signed by:"+MyValue.Comments(1).SecondaryUsername

SecurityGroupList Property (Server Object)

Returns the list of security groups from the current server. Security groups determine the system functions permitted by users within the group.

Syntax

object.SecurityGroupList

Parameters

None

Remarks

SecurityGroupList is a read-only property of type Variant.

SecurityGroupLocation Property (Server Object)

Returns or sets the location of the security groups used by the server. The Historian server can either use security groups assigned to the local server computer ("Local" location) or groups configured for the domain ("Domain" location). Note, changing the SecurityGroupLocation requires a server restart to take effect.

Syntax

object.SecurityGroupLocation[ = String]

Parameters

None

Selected Property (Tag Object)

Returns whether or not this tag is selected.

Syntax

object.Selected[ = Boolean]

Parameters

None

Server Property (Archive Object)

Returns the server associated with the Archive object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyArchive.Server.ServerName

Server Property (Archives Object)

Returns the Server associated with the Archives object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyArchives.Server.ServerName

Server Property (Collector Object)

Returns the Server associated with the Collector Object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyCollector.Server.ServerName

Server Property (Collectors Object)

Returns the Server associated with the Collectors object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyCollectors.Server.ServerName

Server Property (Data Object)

Returns the server associated with the Data object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyDataServer.Server.ServerName

Server Property (DataRecordset Object)

Returns the Server associated with the DataRecordset object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String ' Get The Name Of The Server ServerName = MyRecordset.Server.ServerName

Server Property (DataStores Object)

Returns the Server associated with the DataRecordset object.

Syntax

object.Server() As Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Server Property (MessageRecordset Object)

Returns the Server associated with the DataRecordset object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get the name of the server
                ServerName = MyRecordset.Server.ServerName

Server Property (Messages Object)

Returns the Server associated with the Messages object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get The Name Of The Server
                ServerName = MyMessages.Server.ServerName

Server Property (TagRecordset Object)

Returns the Server associated with the TagRecordset object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get the name of the server
                ServerName = MyRecordset.Server.ServerName

Server Property (Tags Object)

Returns the Server associated with the Tags Object.

Syntax

object.Server

Parameters

None

Remarks

Server is a read-only property of type Server.

Example

  Dim ServerName As String
                ' Get the name of the server
                ServerName = MyTags.Server.ServerName

ServerName Property (Server Object)

Returns the name of the computer that the server is running on.

Syntax

object.ServerName[ = String]

Parameters

None

Remarks

Server is a read-only property of type String.

ServerName Property (Server Object)

Returns the name of the computer that the server is running on.

Syntax

object.ServerName[ = String]

Parameters

None

Remarks

Server is a read-only property of type String.

ServerTime Property (Server Object)

Returns the current time on the connected server. The system then converts the time from UTC into formatted time based on the ConnectionOptions (TimeOption) setting.

Syntax

object.ServerTime

Parameters

None

Servers Property (ServerManager Object)

Maintains a list of registered servers on the client. To connect a listed server, use the Connect Method of a selected Server Object.

Syntax

object.Servers

Parameters

None

SetName Property (EnumeratedSets Object)

Returns or defines the name of an Enumerated Set.

Syntax

object.SetName

Parameters

None

Returns

String

SimpleEvents Property (OPCFilters Object)

Returns the list of Simple Event Categories being filtered on the Alarm Collector. This list is only applied if isSimpleEventsOn(true) has been called.

Syntax

object.SimpleEvents

Parameters

None

SourceAddress Property (Tag Object)

Returns or sets the address used to identify the Tag in the data source. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.SourceAddress[ = String]

Parameters

None

SourceAddress Property (TagCriteria Object)

Sets the tag source address to search for in the TagRecordset query.

Syntax

object.SourceAddress[ = String]

Parameters

None

SourceAddress Property (TagFields Object)

Determines whether the SourceAddress field should be returned in the TagRecordset query.

Syntax

object.SourceAddress[ = Boolean]

Parameters

None

SourceAddressSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SourceAddressSet[ = Boolean]

Parameters

None

SourceAddressUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SourceAddressUpdated[ = Boolean]

Parameters

None

Sources Property (OPCFilters Object)

Returns a list of the Sources selected for collection. This list is only applied when isSourceFiltering (true) has been called.

Syntax

object.Sources[ = Boolean]

Parameters

None

SpikeLogic Property (Tag Object)

Returns or sets whether this tag uses the spike logic compression algorithm.

Syntax

object.SpikeLogic[ = Boolean]

Parameters

None

SpikeLogic Property (TagCriteria Object)

Sets the spike logic to search for in the TagRecordset query.

Syntax

object.SpikeLogic[ = Boolean]

Parameters

None

SpikeLogic Property (TagFields Object)

Determines whether the SpikeLogic field should be returned in the TagRecordset query.

Syntax

object.SpikeLogic[ = Boolean]

Parameters

None

SpikeLogicOverride Property (Tag Object)

Returns or sets whether this tag should use the its own Spike Logic setting or the default Collectors setting.

Syntax

object.SpikeLogicOverride[ = Boolean]

Parameters

None

SpikeLogicOverride Property (TagCriteria Object)

Sets the spike logic override to search for in the TagRecordset query.

Syntax

object.SpikeLogicOverride[ = Boolean]

Parameters

None

SpikeLogicOverride Property (TagFields Object)

Determines whether the SpikeLogicOverride field should be returned in the TagRecordset query.

Syntax

object.SpikeLogicOverride[ = Boolean]

Parameters

None

SpikeLogicOverrideSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SpikeLogicOverrideSet[ = Boolean]

Parameters

None

SpikeLogicOverrideUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SpikeLogicOverrideUpdated[ = Boolean]

Parameters

None

SpikeLogicSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SpikeLogicSet[ = Boolean]

Parameters

None

SpikeLogicUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.SpikeLogicUpdated[ = Boolean]

Parameters

None

StartTime Property (Archive Object)

Returns the start time of the specified archive. This represents the earliest timestamp for any sample contained in the archive.

Syntax

object.StartTime

Parameters

None

StartTime Property (DataCriteria Object)

Returns or sets the start of the time range to retrieve data for in the DataRecordset query.

Syntax

object.StartTime[ = Date]

Parameters

None

StartTime Property (MessageCriteria Object)

Establishes the start time of the MessageRecordset query.

Syntax

object.StartTime[ = Date]

Parameters

None

StartTimeSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StartTimeSet[ = Boolean]

Parameters

None

StartTimeSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StartTimeSet[ = Boolean]

Parameters

None

StartTimeShortcut Property (DataCriteria Object)

Returns or sets the start of the time range to retrieve data for in the DataRecordset query. Shortcuts are strings that define absolute or relative times.

The time shortcuts are the following:

Value	Description
(N)ow	The current time (absolute).
(T)oday	Today at midnight (absolute).
(Y)esterday	Yesterday at midnight (absolute).
(D)ays	Number of Days (relative).
(M)in	Number of Minutes (relative).
(H)our	Number of Hours (relative).
(W)eek	Number of Weeks (relative).
(BOM)	Beginning of this month at Midnight (absolute).
(EOM)	Last Day of this month at Midnight (absolute).
(BOY)	First Day of this year at Midnight (absolute).
(EOY)	Last Day of this year at Midnight (absolute).

Syntax

object.StartTimeShortcut[ = String]

Parameters

None

Example

 With MyRecordset.Criteria   .Tagmask = "*.F_CV"   ' Start two days Ago at 8am in the morning   
.StartTimeShortcut = "Today-2d+8h"   ' End this morning at 8am   
.EndTimeShortcut = "Today+8h" End With

StartTimeShortcut Property (MessageCriteria Object)

Establishes the start time of the MessageRecordset Query by specifying a time shortcut string versus a date.

The time shortcuts are the following:

Value	Description
(N)ow	The current time (absolute).
(T)oday	Today at midnight (absolute).
(Y)esterday	Yesterday at midnight (absolute).
(D)ays	Number of Days (relative).
(M)in	Number of Minutes (relative).
(H)our	Number of Hours (relative).
(W)eek	Number of Weeks (relative).
(BOM)	Beginning of this month at Midnight (absolute).
(EOM)	Last Day of this month at Midnight (absolute).
(BOY)	First Day of this year at Midnight (absolute).
(EOY)	Last Day of this year at Midnight (absolute).

Syntax

object.StartTimeShortcut[ = String]

Parameters

None

Example

'Set A Start Time For Two Days Ago
MyMessages.Criteria.StartTimeShortcut = "-2d"

StartTimeShortcutSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StartTimeShortcutSet[ = Boolean]

Parameters

None

State Property (DataStore Object)

Returns or sets the state of data store. For example, Running.

Syntax

object.State

Parameters

None

Remarks

ihDataStoreState

State Property (DataStore Object)

Returns or sets the state of data store. For example, Running.

Syntax

object.State

Parameters

None

Remarks

ihDataStoreState

State Property (DataStore Object)

Returns or sets the state of data store. For example, Running.

Syntax

object.State

Parameters

None

Remarks

ihDataStoreState

StateLowRawValue Property (EnumeratedState Object)

Returns or defines the minimum value of a state when you are using a range of values for a state. For example, if your state value is from 0 to 5 and it is defined as ON, then this would be 0.

Syntax

object.StateLowRawValue

Parameters

None

Remarks

Variant. Returns the low raw value of the state.

StateValue Property (QueryModifiers Object)

Returns or sets the state value to be used when querying data with the StateCount and StateTime calculation modes.

Syntax

object.StateValue = value

Status Property (Archive Object)

Returns the status of the specified Archive. This status is typically Current or Active.

Syntax

object.Status

Parameters

None

Remarks

Status is a read-only property of type String.

Example

     ' Print Out The Archive Status Debug.Print MyArchive.Status

Status Property (Collector Object)

Returns the status of the specified Collector. This status is typically Running or Stopped.

Syntax

object.Status

Parameters

None

Remarks

Status is a read-only property of type String.

Example

    ' Print Out The Collector Status Debug.Print MyCollector.Status

StepValue Property (Tag Object)

Returns or sets whether this tag is using Step Value or not.

Syntax

object.StepValue[ = Boolean]

Parameters

None

StepValue Property (TagCriteria Object)

Sets the Step Value value to search for in the TagRecordset query.

Syntax

object.StepValue[ = Boolean]

Parameters

None

StepValue Property (TagFields Object)

Determines whether the StepValue field should be returned in the TagRecordset query.

Syntax

object.StepValue[ = Boolean]

Parameters

None

StepValueSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StepValueSet[ = Boolean]

Parameters

None

StepValueUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StepValueUpdated[ = Boolean]

Parameters

None

StorageType Property (DataStore Object)

Returns the type of data store. For example, ScadaBufferStore or Historical Data Store.

Syntax

object.StorageType

Parameters

None

Remarks

ihDataStorageType

StoreMilliseconds Property (Tag Object)

Returns or sets the time resolution of the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMilliseconds Property (TagCriteria Object)

Sets the time resolution to search for in the TagRecordset query.

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMilliseconds Property (TagFields Object)

Determines whether the StoreMilliseconds field should be returned in the TagRecordset query.

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMillisecondsSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StoreMilliseconds[ = Boolean]

Parameters

None

StoreMillisecondsUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StoreMillisecondsUpdated[ = Boolean]

Parameters

None

StoreOPCQuality Property (Server Object)

Returns or sets whether the server stores the raw (16-bit) OPC quality flags.

Syntax

object.StoreOPCQuality[ = Boolean]

Parameters

None

Strict Client Authentication Property

Returns or sets whether to enforce strict client authentication. Setting this value to TRUE will disallow connections from clients older than version 4.7.

Syntax

object.StrictClientAuthentication

Parameters

None

Strict Collector Authentication (Archives Object)

Returns or sets whether to enforce strict client authentication. Setting this value to TRUE will disallow connections from clients older than version 4.7.

Syntax

object.StrictCollectorAuthentication

Parameters

None

StringLength Property (Tag Object)

Returns or sets the fixed string length associated with a fixed string type Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.StringLength[ = Byte]

Parameters

None

StringLength Property (TagFields Object)

Determines whether the StringLength field should be returned in the TagRecordset query.

Syntax

object.StringLength[ = Boolean]

Parameters

None

StringLengthSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StringLengthSet[ = Boolean]

Parameters

None

StringLengthUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.StringLengthUpdated[ = Boolean]

Parameters

None

SubscribeStatus Property (Archives Object)

Subscribes to changes in Archive status and configuration. The Historian server publishes messages to any client signed up for Archive status changes as modifications are committed to the Archive Database. Setting the SubscribeStatus to True signs up for status and configuration changes on all archives.

Status and configuration changes are reported asynchronously to the client through the Status_Received event of the Archives object.

Syntax

object.SubscribeStatus[ = Boolean]

Parameters

None

Example

  ' Subscribe To Archive Status Updates
            MyArchives.SubscribeStatus = True
            ' Unsubscribe To Archive Status Updates
            MyArchives.SubscribeStatus = False

SubscribeStatus Property (Collectors Object)

Subscribes to changes in Collector status and configuration. The Historian server publishes messages to any client signed up for Collector status changes as modifications are committed to the Collector database. Setting the SubscribeStatus to True will sign up for status and configuration changes on all Collectors.

Status and configuration changes are reported asynchronously to the client through the Status_Received event of the Collectors object.

Syntax

object.SubscribeStatus[ = Boolean]

Parameters

None

Example

  ' Subscribe To Collector Status Updates
                MyCollectors.SubscribeStatus = True
                ' Unsubscribe To Collector Status Updates
                MyCollectors.SubscribeStatus = False

Substitutions Property (Message Object)

Returns the variable text of a message such as timestamps, usernames, and tagnames.

Syntax

object.Substitutions

Parameters

None

Remarks

Substitutions is a read-only property of type String.

Example

  Dim MySubstitutions As Collection Dim I As Integer Set MySubstitutions = MyMessage.Substitutions 
For I = 1 To MySubstitutions.count   Debug.Print MySubstitutions(I) Next I

Substitutions Property (MessageFields Object)

Determines whether the Substitutions should be returned in the MessageRecordset query.

Syntax

object.Substitutions[ = Boolean]

Parameters

None

Example

  Dim MyMessages As iHistorian_SDK.MessageRecordset Set MyMessages = GetServer.Messages.NewRecordset With 
MyMessages.Fields   .Topic = True   .TimeStamp = True   .MessageString = True   .Substitutions = True End With

T

Tagmask Property (DataCriteria Object)

Returns or sets a mask of tags to retrieve data for in the DataRecordset query. The tag mask may include wildcard characters including the "*" and "?".

Syntax

object.Tagmask[ = String]

Parameters

None

T

TagmaskSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TagmaskSet[ = Boolean]

Parameters

None

Tagname Property (Tag Object)

Returns the Tagname property of the Tag. Tagname is a read-only property.

Syntax

object.Tagname[ = String]

Parameters

None

Remarks

Tagname is a read-only property of type String.

Tagname Property (Tag Object)

Returns the Tagname property of the Tag. Tagname is a read-only property.

Syntax

object.Tagname[ = String]

Parameters

None

Remarks

Tagname is a read-only property of type String.

Tagname Property (TagCriteria Object)

Sets the Tagname or tag mask to search for in the TagRecordset query. The Tagname may include wildcard characters.

Syntax

object.Tagname[ = String]

Parameters

None

Tagname Property (TagFields Object)

Determines whether the Tagname field should be returned in the TagRecordset query.

Syntax

object.Tagname[ = Boolean]

Parameters

None

TagnameSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TagnameSet[ = Boolean]

Parameters

None

TagnameUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TagnameUpdated[ = Boolean]

Parameters

None

Tags Property (DataCriteria Object)

Returns or sets an array of Tagnames to retrieve data for in the DataRecordset query.

Syntax

object.Tags[ = Variant]

Parameters

None

Tags Property (DataRecordset Object)

Exposes the list of Tagnames associated with the collection of DataValue results maintained in the DataRecordset object. The Item property takes a tagname or tag index as a parameter to expose the collection of DataValues for that tag. The first collection of DataValues in the Item property.

Syntax

object.Tags

Parameters

None

Remarks

Tags is a read-only property of type Collection of String.

Tags Property (Server Object)

Returns the Tags object for the current server, but only if the authenticated user is a member of the Historian tag administrators group.

Syntax

object.Tags

Parameters

None

TagsSet Property (DataCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TagsSet[ = Boolean]

Parameters

None

TimeStamp Property (DataFields Object)

Determines whether the Timestamp field should be returned in the DataRecordset query.

Syntax

object.TimeStamp[ = Boolean]

Parameters

None

TimeStamp Property (DataValue Object)

Returns the timestamp of the DataValue in a localized time.

Syntax

object.TimeStamp

Parameters

None

Remarks

TimeStamp is a read-only property of type Date.

TimeStamp Property (Message Object)

Returns the time the Message was created.

Syntax

object.TimeStamp[ = Date]

Parameters

None

Remarks

TimeStamp is a writeable property of type Date.

TimeStamp Property (MessageFields Object)

Determines whether the TimeStamp field should be returned in the MessageRecordset query.

Syntax

object.TimeStamp[ = Boolean]

Parameters

None

TimeStampType Property (Tag Object)

Returns or sets the type of time stamping applied to data at collection time.

Name	Description	Value
Source	New values take timestamp from data source.	1
Collector	New values are timestamped by Collector.	2

Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.TimeStampType[ = ihTimeStampType]

Parameters

None

TimeStampType Property (TagCriteria Object)

Sets the timestamp type to search for in the TagRecordset query.

Syntax

object.TimeStampType[ = Boolean]

Parameters

None

TimeStampType Property (TagFields Object)

Determines whether the TimeStampType field should be returned in the TagRecordset query.

Syntax

object.TimeStampType[ = Boolean]

Parameters

None

TimeStampTypeSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TimeStampTypeSet[ = Boolean]

Parameters

None

TimeStampTypeUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TimeStampTypeUpdated[ = Boolean]

Parameters

None

TimeZoneBias Property (Tag Object)

Returns or sets the time zone bias for the tag. Time zone bias is used to indicate the natural time zone of the tag expressed as an offset from GMT in minutes. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.

Syntax

object.TimeZoneBias[ = Long]

Parameters

None

TimeZoneBias Property (TagCriteria Object)

Sets the time zone bias to search for in the TagRecordset query.

Syntax

object.TimeZoneBias[ = Long]

Parameters

None

TimeZoneBias Property (TagFields Object)

Determines whether the TimeZoneBias field should be returned in the TagRecordset query.

Syntax

object.TimeZoneBias[ = Boolean]

Parameters

None

TimeZoneBiasUpdated Property (Tag Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TimeZoneBiasUpdated[ = Boolean]

Parameters

None

TimeZoneBiasSet Property (TagCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TimeZoneBiasSet[ = Boolean]

Parameters

None

TimestampTypeList Property (Tags Object)

Returns a list of the valid Timestamp types available in Historian.

Syntax

object.TimestampTypeList

Parameters

None

Topic Property (Message Object)

Returns the Topic Number of the Message.

Syntax

object.Topic[ = ihMessageTopic]

Parameters

None

Remarks

Topic is a writeable property of type ihMessageTopic.

Example

    If MyMessage.Topic = ihMessageTopic.General Then   Debug.Print "This is a General Message" End If

Topic Property (MessageCriteria Object)

Establishes which Topic the MessageRecordset query will filter by.

Syntax

object.Topic[ = ihMessageTopic]

Parameters

None

Remarks

Topic is a writeable property of type ihMessageTopic.

Example

   MyMessages.Criteria.Topic = ihMessageTopic.General

Topic Property (MessageFields Object)

Determines whether the Topic field should be returned in the MessageRecordset query.

Syntax

object.Topic[ = Boolean]

Parameters

None

Remarks

Topic is a writeable property of type ihMessageTopic.

Example

Dim MyMessages As iHistorian_SDK.MessageRecordset Set MyMessages = GetServer.Messages.NewRecordset With MyMessages.Fields   .Topic = True End With

TopicList Property (Messages Object)

Returns a list of available Topics.

Syntax

object.TopicList([IncludeMessages], [IncludeAlerts])

Parameters

Name	Data Type	Description
IncludeMessages	Boolean	Indicates whether Message topics should be included in the returned list
IncludeAlerts	Boolean	Indicates whether Alert topics should be included in the returned list

TopicName Property (Message Object)

Returns the Topic Name of the Message.

Syntax

object.TopicName

Parameters

None

Remarks

Topic is a writeable property of type String.

Example

Debug.Print "This is a " + MyMessage.TopicName + " message."

TopicSet Property (MessageCriteria Object)

A flag to indicate whether this property has been set or not.

Syntax

object.TopicSet[ = Boolean]

Parameters

None

TrackingEvents Property (OPCFilters Object)

Returns the list of Tracking Event Categories being filtered on the Alarm Collector. This list is only applied if isTrackingEventsOn(true) has been called.

Syntax

object.TrackingEvents

Parameters

None