Variable Properties
Installed With: Base Package
View the class hierarchy.
Use these properties to configure shared variables. You also can use the Variable Reference property with the Variable properties to configure shared variables programmatically. Changes you make using the Variable properties take effect after you save the project library. These properties are similar to the options on the Variable page of the Shared Variable Properties dialog box.
| Property | Description |
|---|---|
| Alarming:BadStatus:AckType | Gets or sets how the Bad Status alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:BadStatus:AllowLog | If TRUE, LabVIEW enables alarm logging for the Bad Status alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:BadStatus:Area | Gets or sets a descriptive area name for the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:BadStatus:Description | Gets or sets the description of the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:BadStatus:Enabled | If TRUE, LabVIEW enables the Bad Status alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:BadStatus:Name | Gets or sets the name of the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:BadStatus:Priority | Gets or sets the priority of the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:AckType | Gets or sets how the DISCRETE alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:AlarmOn | Gets or sets whether a shared variable is in alarm state when the value is either high (TRUE) or low (FALSE). To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:AllowLog | If TRUE, LabVIEW enables alarm logging for the DISCRETE alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:Area | Gets or sets a descriptive area name for the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:Description | Gets or sets the description of the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:Enabled | If TRUE, LabVIEW enables the DISCRETE alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:Name | Gets or sets the name of the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Boolean:Priority | Gets or sets the priority of the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Enabled | If TRUE, LabVIEW enables alarming for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Event On Data Change | If TRUE, LabVIEW sets an event for a shared variable when data changes. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:AckType | Gets or sets how the HI alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:AllowLog | If TRUE, LabVIEW enables alarm logging for the HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Area | Gets or sets a descriptive area name for the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Deadband | Gets or sets the HI alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Description | Gets or sets the description of the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Enabled | If TRUE, LabVIEW enables the HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Level | Gets or sets the value, in engineering units, that evokes the HI alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Name | Gets or sets the name of the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Hi:Priority | Gets or sets the priority of the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:AckType | Gets or sets how the HI_HI alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:AllowLog | If TRUE, LabVIEW enables alarm logging for the HI_HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Area | Gets or sets a descriptive area name for the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Deadband | Gets or sets the HI_HI alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Description | Gets or sets the description of the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Enabled | If TRUE, LabVIEW enables the HI_HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Level | Gets or sets the value, in engineering units, that evokes the HI_HI alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Name | Gets or sets the name of the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:HiHi:Priority | Gets or sets the priority of the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:AckType | Gets or sets how the LO alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:AllowLog | If TRUE, LabVIEW enables alarm logging for the LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Area | Gets or sets a descriptive area name for the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Deadband | Gets or sets the LO alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Description | Gets or sets the description of the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Enabled | If TRUE, LabVIEW enables the LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Level | Gets or sets the value, in engineering units, that evokes the LO alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Name | Gets or sets the name of the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:Lo:Priority | Gets or sets the priority of the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:AckType | Gets or sets how the LO_LO alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:AllowLog | If TRUE, LabVIEW enables alarm logging for the LO_LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Area | Gets or sets a descriptive area name for the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Deadband | Gets or sets the LO_LO alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Description | Gets or sets the description of the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Enabled | If TRUE, LabVIEW enables the LO_LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Level | Gets or sets the value, in engineering units, that evokes the LO_LO alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Name | Gets or sets the name of the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:LoLo:Priority | Gets or sets the priority of the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:AckType | Gets or sets how the Rate of Change alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:AllowLog | If TRUE, LabVIEW enables alarm logging for the Rate of Change alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Area | Gets or sets a descriptive area name for the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Change | Gets or sets the value that a shared variable value must change in the specified time to trigger the Rate of Change alarm. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Description | Gets or sets the description of the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Enabled | If TRUE, LabVIEW enables the Rate of Change alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Name | Gets or sets the name of the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Priority | Gets or sets the priority of the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:RateOfChange:Time | Gets or sets the amount of time, in milliseconds, in which a shared variable value must change at least the value of the Alarming:RateOfChange:Change property to trigger the Rate of Change alarm. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:AckType | Gets or sets how the BIT_ARRAY alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:AlarmOn | Gets or sets whether a shared variable generates an alarm when any bit (1) is in alarm state or only when all bits (0) are in alarm state. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:AllowLog | If TRUE, LabVIEW enables alarm logging for the BIT_ARRAY alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:Area | Gets or sets a descriptive area name for the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:Description | Gets or sets the description of the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:Enabled | If TRUE, LabVIEW enables the BIT_ARRAY alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:InvertMask | Gets or sets which bits of a shared variable alarm on high, 1, and which bits alarm on low, 0. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:Name | Gets or sets the name of the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:Priority | Gets or sets the priority of the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Alarming:U32BitField:SelectMask | Gets or sets which bits LabVIEW uses to calculate the alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Data Type (Variant) | Sets the data type of the variable to the data type you wire to this property. Details |
| Description | Gets or sets the description of a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Initial Value:Enabled | If TRUE, LabVIEW enables initial value setting for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Initial Value:Initial Value | Gets or sets the initial value for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:Deadband | Gets or sets the deadband for logging a shared variable in the Citadel historical database. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:Enabled | If TRUE, LabVIEW enables logging for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:LogData | If TRUE, LabVIEW logs data for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:LogEvents | If TRUE, LabVIEW logs events for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:String Format | Sets the logging string format. LabVIEW ignores this property if the data type of the variable is not a string. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:TimeResolution | Gets or sets the resolution, in seconds, for logging a shared variable value in the Citadel historical database. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Logging:ValueResolution | Gets or sets the resolution, in engineering units, for logging the shared variable value in the Citadel historical database. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Name | Gets or sets the shared variable name. Details |
| Network:AccessType | Specifies whether a shared variable reads, writes, or reads and writes data. Details |
| Network:BuffSize | Gets or sets the size of the network buffer. Details |
| Network:ElemSize | Gets or sets the size, in number of values, of the network buffer. For arrays, gets or sets the number of elements in the array. For strings, gets or sets the number of characters in the string. Details |
| Network:PointsPerWaveform | The number of points in each waveform in the buffer. Details |
| Network:ProjectBinding | Indicates if the variable is bound to a project item or a URL. If TRUE, the variable is bound to a project item. If FALSE, the variable is bound to a URL. Details |
| Network:ProjectPath | Gets or sets the path to a shared variable in the active LabVIEW project to which you want to bind the shared variable you are configuring. Details |
| Network:URL | Gets or sets the path to a shared variable inside another project or to the data item to which you want to bind the shared variable you are configuring. Details |
| Network:UseBinding | If TRUE, LabVIEW binds a shared variable to an existing shared variable in the active project, an existing shared variable in another project, or an NI Publish-Subscribe Protocol data item on the network. The default is FALSE. Details |
| Network:UseBuffering | If TRUE, LabVIEW enables buffering for a shared variable. The default is FALSE. Details |
| Real-Time:ArrayLength | Gets or sets the length of the array for a shared variable with a fixed length array data type. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Real-Time:BufferLength | Gets or sets the length of the real-time first-in-first-out (FIFO) buffer for a shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Real-Time:DatapointsInWaveform | Gets or sets the number of data points for a shared variable with a Data Type of Waveform. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Real-Time:Enabled | If TRUE, LabVIEW enables the real-time first-in-first-out (FIFO) features for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Real-Time:UseBuffering | If TRUE, LabVIEW uses the configuration you specify in the Use Buffering section of the Network page of the Shared Variable Properties dialog box to configure the size and elements of a real-time first-in-first-out (FIFO) buffer for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Scaling:Coerce | If TRUE, LabVIEW coerces the shared variable data to a range you specify. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:Enabled | If TRUE, LabVIEW scales the shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:EngineeringMax | Gets or sets the full scale, or maximum value, that the Shared Variable Engine and Human Machine Interface (HMI) application use for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:EngineeringMin | Gets or sets the zero scale, or minimum value, that the Shared Variable Engine and Human Machine Interface (HMI) application use for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:EngUnit | Specifies the engineering unit for the shared variable. Details |
| Scaling:Invert | If TRUE, LabVIEW inverts the data the server sends before storing it in a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:InvertMask | Gets or sets the bits that the Shared Variable Engine inverts before storing them in a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:RawMax | Gets or sets the full scale, or maximum value, that the server uses for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:RawMin | Gets or sets the zero scale, or minimum value, that the server uses for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:SelectMask | Gets or sets the bits the Shared Variable Engine uses for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Scaling:Type | Gets or sets the type of scaling to perform on a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Single-Process:Enable Timestamp | If TRUE, a timestamp value is recorded each time the single-process shared variable reads data. To view timestamp information and add a timestamp output to the Shared Variable node, right-click the Shared Variable node and select Show Timestamp from the shortcut menu. If this property is FALSE, the timestamp output is hidden. You can use this property only with single-process shared variables. The default value is FALSE. Details |
| Time-Triggered:Enabled | If TRUE, LabVIEW enables the deterministic features for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:GUID | Gets or sets a globally unique identifier for a time-triggered shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:Max Size | Gets or sets the maximum size, in bytes, for the data type of a time-triggered shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:Slot Offset | Gets or sets the number of microseconds you want LabVIEW to wait before writing to a slot-based, time-triggered shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:SMB Array Number Of Elements | Gets or sets the number of elements in an array or a string for a time-triggered shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:SMB Variable | If TRUE, specifies that the deterministic shared variable is of the shared memory block variety. The default is FALSE. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:Table Index | Gets or sets the table index of a time-triggered shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Time-Triggered:Transmission Time | Gets or sets the time, in microseconds, that LabVIEW takes to send a deterministic shared variable. To use this property, you must install the LabVIEW Real-Time Module. Details |
| Type | Gets or sets the scope of a shared variable. Valid values include 0 (a single-process shared variable), 1 (a network-published shared variable), and 2 (time-triggered shared variable, when the LabVIEW Real-Time Module is installed). Details |
| Update Deadband:Enabled | Enables the update deadband for a shared variable. If TRUE, LabVIEW updates the value of a shared variable only if the percentage difference between the new value and the previous value equals or exceeds the deadband. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Update Deadband:Source | Gets or sets the deadband for updating the value of a shared variable when the value for the binding source changes. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |
| Update Deadband:User | Gets or sets the deadband for updating the value of a shared variable when a user writes data to the variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module. Details |