AF SDK Reference

AFData.EndOfStream Method

Save PDF

TABLE OF CONTENTS

AFData.EndOfStream Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Returns the end-of-stream AFValue.

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

Syntax

public AFValue EndOfStream(
	UOM desiredUOM
)

Public Function EndOfStream ( 
	desiredUOM As UOM
) As AFValue

Dim instance As AFData
Dim desiredUOM As UOM
Dim returnValue As AFValue

returnValue = instance.EndOfStream(desiredUOM)

public:
AFValue^ EndOfStream(
	UOM^ desiredUOM
)

member EndOfStream : 
        desiredUOM : UOM -> AFValue

Parameters

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 last recorded event. In the case of calculation based data references, it will normally indicate the latest input value's end-of-stream timestamp.

Remarks

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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7

AF SDK Reference