Property Reference I-J
I
Id Property (DataStore Object)
Returns or sets the ID (GUID) of a data store. This is a read-only property.
Syntax
object.Id
Parameters
None
Remarks
String. This is a read-only property.
ImportErrors Property (Alarms Object)
Returns a list of Import Error messages.
Syntax
object.ImportErrors
Parameters
None
ImportErrors Property (DataRecordset Object)
Returns a list of Import Error messages.
Syntax
object.ImportErrors
Parameters
None
ImportErrors Property (MessageRecordset Object)
Returns a list of Import Errors.
Syntax
object.ImportErrors
Parameters
None
ImportErrors Property (TagRecordset Object)
Returns a list of tag import errors.
Syntax
object.ImportErrors
Parameters
None
InputScaling Property (Tag Object)
Returns or sets whether input scaling is enabled for the Tag. Changes to tag properties are not committed until you call the WriteRecordset method of the TagRecordset object.
Syntax
object.InputScaling[ = Boolean]
Parameters
None
InputScaling Property (TagCriteria Object)
Sets the input scaling to search for in the TagRecordset query.
Syntax
object.InputScaling[ = Boolean]
Parameters
None
InputScaling Property (TagFields Object)
Determines whether the InputScaling field should be returned in the TagRecordset query.
Syntax
object.InputScaling[ = Boolean]
Parameters
None
InputScalingSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.InputScalingSet[ = Boolean]
Parameters
None
InputScalingUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.InputScalingUpdated[ = Boolean]
Parameters
None
IsSystem Property (DataStore Object)
Indicates or sets that data store is the single System Data Store and therefore, cannot be modified.
Syntax
object.IsSystem
Parameters
None
InterfaceAbsoluteDeadband Property (Tag Object)
Returns or sets the Absolute Deadband value for this tag to be used in the Collector.
Syntax
object.InterfaceAbsoluteDeadband[ = Double]
Parameters
None
InterfaceAbsoluteDeadband Property (TagCriteria Object)
Sets the InterfaceAbsoluteDeadband to search for in the TagRecordset query.
Syntax
object.InterfaceAbsoluteDeadband[ = Double]
Parameters
None
InterfaceAbsoluteDeadband Property (TagFields Object)
Determines whether the InterfaceAbsoluteDeadband field should be returned in the TagRecordset query.
Syntax
object.InterfaceAbsoluteDeadband[ = Double]
Parameters
None
InterfaceAbsoluteDeadbandSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.InterfaceAbsoluteDeadbandSet[ = Boolean]
Parameters
None
InterfaceAbsoluteDeadbandUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.InterfaceAbsoluteDeadbandUpdated[ = Boolean]
Parameters
None
InterfaceAbsoluteDeadbanding Property (Tag Object)
Returns or sets whether this tag is using Absolute Deadbanding in the Collector or not.
Syntax
object.InterfaceAbsoluteDeadbanding[ = Boolean]
Parameters
None
InterfaceAbsoluteDeadbanding Property (TagCriteria Object)
Sets the InterfaceAbsoluteDeadbanding to search for in the TagRecordset query.
Syntax
object.InterfaceAbsoluteDeadbanding[ = Boolean]
Parameters
None
InterfaceAbsoluteDeadbanding Property (TagFields Object)
Determines whether the InterfaceAbsoluteDeadbanding field should be returned in the TagRecordset query.
Syntax
object.InterfaceAbsoluteDeadbanding[ = Boolean]
Parameters
None
InterfaceAbsoluteDeadbandingSet Property (TagCriteria Object)
A flag to indicate whether this property has been set or not.
Syntax
object.InterfaceAbsoluteDeadbandingSet[ = Boolean]
Parameters
None
InterfaceAbsoluteDeadbandingUpdated Property (Tag Object)
A flag to indicate whether this property has been set or not.
Syntax
object.InterfaceAbsoluteDeadbandingUpdated[ = Boolean]
Parameters
None
IsActiveRedundantCollector Property (Collector Object)
Returns whether this collector is currently the active collector in a redundant set of collectors.
Syntax
object.IsActiveRedundantCollector
Parameters
None
Remarks
IsActiveRedundantCollector is a read-only property of type Boolean.
IsAudited Property (Data Object)
Returns whether or not this data has an Audit Trail associated with it.
Syntax
object.IsAudited
Parameters
None
IsAudited Property (Server Object)
Returns or sets whether the point verification feature is enabled. With point verification enabled, the system will prompt for a username and password upon any request to change data or configuration.
Syntax
object.IsAudited[ = Boolean]
Parameters
None
IsCurrent Property (Archive Object)
Returns whether or not the specified archive is the newest archive where new data currently flows into.
Syntax
object.IsCurrent
Parameters
None
Remarks
IsCurrent is a read-only property of type Boolean.
Example
'Find The Current Archive, Then Initiate A Backup With MyArchives
For I = 1 To .Item.count If .Item(I).IsCurrent Then
If Not .Item(I).Backup(BackupFilename) Then err.Raise 1, "Backup", "Backup Failed" End If
End If Next I End WithIsDefaultServer Property (Server Object)
Returns and/or determines if the current server is the default server. You can create an instance of the Server object and connect it without supplying a server name, username, or password. In this case, the default server and associated user information establishes the default connection.
Syntax
object.IsDefaultServer
Parameters
None
IsDeleted Property (DataValue Object)
This function returns a Boolean which indicates whether or not this DataValue has been deleted or not.
Syntax
object.IsDeleted
Parameters
None
IsDeleted Property (Tag Object)
Returns whether or not this tag has been deleted.
Syntax
object.IsDeleted
Parameters
None
Modified Property (DataValue Object)
This function returns Boolean which indicates whether or not any of this DataValue's fields have been modified.
Syntax
object.IsModified
Parameters
None
IsModified Property (Tag Object)
Returns whether or not this tag has been modified.
Syntax
object.IsModified
Parameters
None
IsNew Property (DataComments Object)
Returns whether or not this Comment is new or not.
Syntax
object.IsNew
Parameters
None
IsNew Property (DataValue Object)
This function returns a Boolean which indicates whether or not this DataValue is new.
Syntax
object.IsNew
Parameters
None
IsNew Property (Message Object)
Returns whether this is a new message or not.
Syntax
object.IsNew
Parameters
None
IsNew Property (Tag Object)
Tag.IsNew indicates whether this is a newly created tag. Returns true if the tag ?s name does not exist in the server.
Syntax
object.IsNew
Parameters
None
Item Property (Archives Object)
Returns a specific Archive object contained in the Archives object. The Item collection can loop through all Archives, or reference a specific Archive object directly by archive name.
The Archive Item collection automatically populates when the Archives object is instantiated.
Syntax
object.Item
Parameters
None
Remarks
Item is a read-only property of type Collection of Archives.
Item Property (Collectors Object)
Returns a specific Collector object contained in the Collectors Object collection. The Item collection can loop through all Collectors, or reference a specific Collector object directly by Collector name.
The Collector Item collection automatically populates when the Collectors object is instantiated.
Syntax
object.Item
Parameters
None
Remarks
Item is a read-only property of type Collection.
Item Property (DataRecordset Object)
Returns a specific DataValue object contained in the DataRecordset object. The Item collection can loop through all DataValues, or reference a specific DataValue object directly by Tagname and Timestamp.
The DataRecordset (and thus the Item collection) is populated with DataValues in three ways. The first is to set up query criteria and call the QueryRecordset method. The second is to import a list of DataValues using the Import method. The last way is to use the Add method to add new DataValues.
Syntax
object.Item(Tagname)
Parameters
Tagname - Variant - The name of the tag whose values to retrieve.
Remarks
Item is a read-only property of type Collection of DataValue.
Item Property (DataStores Object)
Returns a specific data store object contained in the DataStores Object collection. The Item collection can loop through all DataStores, or reference a specific DataStore object directly by DataStore name.
Syntax
object.Item() As Collection
Parameters
NoneRemarks
Item is a read-only property of type Collection.
Item Property (EnumeratedStates Object)
Returns an individual item from the EnumeratedStates collection.
Parameters
NoneRemarks
Enumerated State.
Item Property (MessageRecordset Object)
Returns a specific Message object contained in the MessageRecordset object. The Item collection can loop through all Messages or reference a specific Message object directly by the timestamp.
The MessageRecordset (and thus the Item collection) populates with the Message in two ways: set up query criteria and call the QueryRecordset method, or use the Add method to add new Messages. Item is a read-only property of type Collection of Message.
Syntax
object.Item
Parameters
None
Item Property (TagDependencies Object)
This function attempts to find the given Tagname within the collection of currently configured tags.
Syntax
object.Item(Tagname)
Parameters
Tagname - Variant - Name of the tag to locate.
Item Property (TagRecordset Object)
Returns a specific Tag object contained in the TagRecordset object. The Item collection can loop through all Tags, or reference a specific Tag object directly by the tag name.
The TagRecordset (and thus the Item collection) populates with Tags in three ways:
The first is to set up query criteria and call the QueryRecordset method. The second is to import a list of Tags using the Import method. The last way is to use the Add method to add new Tags.
Syntax
object.Item
Parameters
None
Remarks
Item is a read-only property of type Collection of Tag.
Item Property (UserDefinedTypeFields Object)
Returns an individual item from the multiple fields of the User Defined Type.
Syntax
object.item(Index)
Parameters
Index - Variant - The index has to be returned.
Remarks
UserDefinedTypeField.