AddField

<< Click to Display Table of Contents >>

 

AddField

AddField(FieldName, [Type], [MinRecTime], [MaxRecTime], [DeadBand], [DeadBandUnit], [ScanTime])

This method is responsible for inserting temporary Tags on a Session's structure. If its optional parameters are not informed, the values defined during the creation of this Session using Storage's CreateNewSession method are used. This method's parameters are described on the next table.

Parameters of the AddField method

Parameter

Description

FieldName

Name of a temporary Tag (mandatory). Please check the general Name property for more information about the allowed characters on the names of objects

Type

Tag's type. Possible values are 0: Double, 1: Bit, 2: Text, or 3: Integer. If this parameter is omitted, uses the value 0: Double

MinRecTime

Minimum time interval between recordings. If this parameter is omitted, uses the value 0 (zero)

MaxRecTime

Maximum time interval without recordings. If this parameter is omitted, uses the value 3600

DeadBand

Temporary Tag's dead band. If this parameter is omitted, uses the value 1 (one)

DeadBandUnit

Temporary Tag's dead band unit. Possible values are 0: Percentage or 1: Absolute. If this parameter is omitted, uses the value 1: Absolute

ScanTime

Temporary Tag's scan time. If this parameter is omitted, uses the value 0 (zero)

 

This method returns True if a Tag was correctly added to this Session and False otherwise.

Was this page useful?