AF SDK Reference

AFData.RecordedValue Method

Save PDF

TABLE OF CONTENTS

AFData.RecordedValue Method

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Returns a single recorded AFValue based on the passed time and mode.

Namespace: OSIsoft.AF.Data
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public AFValue RecordedValue(
	AFTime time,
	AFRetrievalMode mode,
	UOM desiredUOM
)

Public Function RecordedValue ( 
	time As AFTime,
	mode As AFRetrievalMode,
	desiredUOM As UOM
) As AFValue

Dim instance As AFData
Dim time As AFTime
Dim mode As AFRetrievalMode
Dim desiredUOM As UOM
Dim returnValue As AFValue

returnValue = instance.RecordedValue(time, 
	mode, desiredUOM)

public:
AFValue^ RecordedValue(
	AFTime time, 
	AFRetrievalMode mode, 
	UOM^ desiredUOM
)

member RecordedValue : 
        time : AFTime * 
        mode : AFRetrievalMode * 
        desiredUOM : UOM -> AFValue

Parameters

time: Type: OSIsoft.AF.TimeAFTime
The time at which the value is desired.
mode: 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.
desiredUOM: Type: OSIsoft.AF.UnitsOfMeasureUOM
The desired unit of measure for the returned value. If , then the value is returned in the unit of measure specified by the associated attribute's DefaultUOM property.

Return Value

Type: AFValue
Returns the AFValue for the attribute. If AFValue.IsGood returned by the data reference is , then the returned value is converted to the proper UOM and Type. The timestamp of the value will indicate the time of the recorded event. In the case of calculation based data references, it will normally indicate the closest input value's recorded value timestamp.

Exceptions

Exception	Condition
NotSupportedException	The data reference does not support this method.

Remarks

To retrieve recorded values for multiple attributes, use the AFListData.RecordedValue to achieve better performance.

Notes to Callers
This method, property, or class is not available in the legacy .NET 3.5 version of the SDK.

Security Note
You must have ReadData security rights to read a data value.

AF SDK Reference