PIPoint.RecordedValue Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Returns a single recorded AFValue based on the
passed time and mode.
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFValue RecordedValue( AFTime time, AFRetrievalMode mode = AFRetrievalMode.Auto )
Public Function RecordedValue ( time As AFTime, Optional mode As AFRetrievalMode = AFRetrievalMode.Auto ) As AFValue Dim instance As PIPoint Dim time As AFTime Dim mode As AFRetrievalMode Dim returnValue As AFValue returnValue = instance.RecordedValue(time, mode)
public: AFValue^ RecordedValue( AFTime time, AFRetrievalMode mode = AFRetrievalMode::Auto )
member RecordedValue : time : AFTime * ?mode : AFRetrievalMode (* Defaults: let _mode = defaultArg mode AFRetrievalMode.Auto *) -> AFValue
Parameters
- time
- Type: OSIsoft.AF.TimeAFTime
The time at which the value is desired. - mode (Optional)
- Type: OSIsoft.AF.DataAFRetrievalMode
The mode is used to determine the value to return when a value does not exist at the exact time specified. The value is taken from the AFRetrievalMode enumeration.
Return Value
Type: AFValueReturns the AFValue for the PI point. The time stamp of the value will indicate the time of the recorded event.
Exceptions
| Exception | Condition |
|---|---|
| PIException | Error returned by the PI Data Archive. |
Remarks
| This method, property, or class is not available in the legacy .NET 3.5 version of the SDK. |