Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFErrors(TKey) Class

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFErrors(TKey) Class
This class is used to return error information.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFErrorsTKey
    OSIsoft.AFAFKeyedResultsTKey, TResult
    OSIsoft.AFAFListResultsTKey, TResult

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

Syntax

public class AFErrors<TKey>
Public Class AFErrors(Of TKey)

Dim instance As AFErrors(Of TKey)
generic<typename TKey>
public ref class AFErrors
type AFErrors<'TKey> =  class end

Type Parameters

TKey
The type of keys in the Errors dictionary.

The AFErrorsTKey type exposes the following members.

Constructors

  NameDescription
Public method
AFErrorsTKey
Initializes a new instance of the AFErrorsTKey class

Properties

  NameDescription
Public property
Errors
The dictionary of all errors that may or may not be specific to a PISystem or PIServer.
Public property
HasErrors
Indicates if any errors were returned from the method.
Public property
PIServerErrors
The dictionary of errors for a PIServer.
Public property
PISystemErrors
The dictionary of errors for a PISystem.

Methods

  NameDescription
Public method
AddError
Add an error that is not specific to a PISystem or PIServer.
Public method
AddPIServerError
Add a PIServer specific error.
Public method
AddPISystemError
Add a PISystem specific error.
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
ToString
Returns a string that represents the current object.
(Inherited from Object.)

Remarks

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

Version Information

AFSDK


See Also

TitleResults for “How to create a CRG?”Also Available in