AFEventFrame.AreValuesCaptured Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This property indicates whether the AFEventFrame has captured its
AFAttribute values.
Namespace: OSIsoft.AF.EventFrame
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool AreValuesCaptured { get; }
Public ReadOnly Property AreValuesCaptured As Boolean Get Dim instance As AFEventFrame Dim value As Boolean value = instance.AreValuesCaptured
public: property bool AreValuesCaptured { bool get (); }
member AreValuesCaptured : bool with get
Property Value
Type: BooleanIndicates whether the AFEventFrame has captured its AFAttribute values so they are cached and any AFDataReference is not evaluated when reading their values.
Remarks
An AFEventFrame will capture its AFAttribute values when the AFEventFrameCaptureValues method is called. This method will evaluate the attribute values for the event frame and cache them so that the AFDataReference will not be used to read their values in the future. The AFEventFrameCaptureValues method can be called again to force the attribute values to be evaluated again and update their cached values.
The cached values are also evaluated again if the StartTime or EndTime are modified and the values are currently captured. Setting the EndTime to MaxValue will clear the captured values.