AF SDK Reference

AFKeyedResults(TKey, TResult) Class

Save PDF

TABLE OF CONTENTS

AFKeyedResults(TKey, TResult) Class

Save PDF

Last UpdatedNov 18, 2025
5 minute read

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

Inheritance Hierarchy

SystemObject
OSIsoft.AFAFErrorsTKey
OSIsoft.AFAFKeyedResultsTKey, TResult

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

Syntax

public sealed class AFKeyedResults<TKey, TResult> : AFErrors<TKey>, 
	IEnumerable<TResult>, IEnumerable

Public NotInheritable Class AFKeyedResults(Of TKey, TResult)
	Inherits AFErrors(Of TKey)
	Implements IEnumerable(Of TResult), IEnumerable

Dim instance As AFKeyedResults(Of TKey, TResult)

generic<typename TKey, typename TResult>
public ref class AFKeyedResults sealed : public AFErrors<TKey>, 
	IEnumerable<TResult>, IEnumerable

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

Type Parameters

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

The AFKeyedResultsTKey, TResult type exposes the following members.

Constructors

	Name	Description
	AFKeyedResultsTKey, TResult	Initializes a new instance of the AFKeyedResultsTKey, TResult class.
	AFKeyedResultsTKey, TResult(Int32)	Initializes a new instance of the AFKeyedResultsTKey, 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 item with the specified key.
	PIServerErrors	The dictionary of errors for a PIServer. (Inherited from AFErrorsTKey.)
	PISystemErrors	The dictionary of errors for a PISystem. (Inherited from AFErrorsTKey.)
	Results	The dictionary 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 dictionary.
	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.)
	TryGetValue	Gets the value associated with the specified key.

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 dictionary 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