AFDataReference.RecordedValueAsync Method

public virtual Task<AFValue> RecordedValueAsync(
	AFTime time,
	AFRetrievalMode mode,
	AFAttributeList inputAttributes,
	AFValues inputValues,
	CancellationToken cancellationToken
)

Public Overridable Function RecordedValueAsync ( 
	time As AFTime,
	mode As AFRetrievalMode,
	inputAttributes As AFAttributeList,
	inputValues As AFValues,
	cancellationToken As CancellationToken
) As Task(Of AFValue)

Dim instance As AFDataReference
Dim time As AFTime
Dim mode As AFRetrievalMode
Dim inputAttributes As AFAttributeList
Dim inputValues As AFValues
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFValue)

returnValue = instance.RecordedValueAsync(time, 
	mode, inputAttributes, inputValues, 
	cancellationToken)

public:
virtual Task<AFValue^>^ RecordedValueAsync(
	AFTime time, 
	AFRetrievalMode mode, 
	AFAttributeList^ inputAttributes, 
	AFValues^ inputValues, 
	CancellationToken cancellationToken
)

abstract RecordedValueAsync : 
        time : AFTime * 
        mode : AFRetrievalMode * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues * 
        cancellationToken : CancellationToken -> Task<AFValue> 
override RecordedValueAsync : 
        time : AFTime * 
        mode : AFRetrievalMode * 
        inputAttributes : AFAttributeList * 
        inputValues : AFValues * 
        cancellationToken : CancellationToken -> Task<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.

inputAttributes

Type: OSIsoft.AF.AssetAFAttributeList
The input attributes as previously specified by the data reference in the GetInputs(Object) call. The index of the values will match the index of the corresponding attribute previously returned. These values must be converted to the appropriate UOM required by this data reference.

inputValues

Type: OSIsoft.AF.AssetAFValues
The input values are supplied to the data reference based on the attributes returned in the GetInputs(Object) call. The index of the values will match the index of the corresponding attribute previously returned. These values must be converted to the appropriate UOM required by this data reference.

cancellationToken

Type: System.ThreadingCancellationToken
A cancellation token used to abort processing before completion. Passing the default CancellationToken.None will run to completion or until the PIConnectionInfo.OperationTimeOut period elapses.

Return Value

AFSDK

Reference