AF SDK Reference

AFListResults(TKey, TResult) Class

Save PDF

TABLE OF CONTENTS

AFListResults(TKey, TResult) Class

Save PDF

Last UpdatedNov 18, 2025
5 minute read

This class is used to return a list of results along with error information.

Inheritance Hierarchy

SystemObject
OSIsoft.AFAFErrorsTKey
OSIsoft.AFAFListResultsTKey, TResult

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

Syntax

public sealed class AFListResults<TKey, TResult> : AFErrors<TKey>, 
	IList<TResult>, ICollection<TResult>, IEnumerable<TResult>, 
	IEnumerable

Public NotInheritable Class AFListResults(Of TKey, TResult)
	Inherits AFErrors(Of TKey)
	Implements IList(Of TResult), ICollection(Of TResult), 
	IEnumerable(Of TResult), IEnumerable

Dim instance As AFListResults(Of TKey, TResult)

generic<typename TKey, typename TResult>
public ref class AFListResults sealed : public AFErrors<TKey>, 
	IList<TResult>, ICollection<TResult>, IEnumerable<TResult>, 
	IEnumerable

[<SealedAttribute>]
type AFListResults<'TKey, 'TResult> =  
    class
        inherit AFErrors<'TKey>
        interface IList<'TResult>
        interface ICollection<'TResult>
        interface IEnumerable<'TResult>
        interface IEnumerable
    end

Type Parameters

TKey: The type of keys in the Errors dictionary.
TResult: The type of values in the Results list.

The AFListResultsTKey, TResult type exposes the following members.

Constructors

	Name	Description
	AFListResultsTKey, TResult	Initializes a new instance of the AFListResultsTKey, TResult class.
	AFListResultsTKey, TResult(Int32)	Initializes a new instance of the AFListResultsTKey, TResult class.

Properties

	Name	Description
	Count	Gets the number of items actually contained in the collection.
	Errors	The dictionary of all errors that may or may not be specific to a PISystem or PIServer. (Inherited from AFErrorsTKey.)
	HasErrors	Indicates if any errors were returned from the method. (Inherited from AFErrorsTKey.)
	Item	Gets the result located at the provided index in the list.
	PIServerErrors	The dictionary of errors for a PIServer. (Inherited from AFErrorsTKey.)
	PISystemErrors	The dictionary of errors for a PISystem. (Inherited from AFErrorsTKey.)
	Results	The list of results returned from a method.

Methods

	Name	Description
	AddError	Add an error that is not specific to a PISystem or PIServer. (Inherited from AFErrorsTKey.)
	AddPIServerError	Add a PIServer specific error. (Inherited from AFErrorsTKey.)
	AddPISystemError	Add a PISystem specific error. (Inherited from AFErrorsTKey.)
	AddResult	Add a result to the Results list.
	AddResults	Add a list of results to the Results list.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	ChunkedByTResult	This extension method breaks up search results into chunks to make it easier to page through and process IEnumerableT collections in chunks. (Defined by AFSDKExtension.)

Remarks

This class is used to return a list of results along with error information from methods. This allows a list of inputs to be matched with the returned results and any errors.

AF SDK Reference