AFErrors(TKey) Class
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
This class is used to return error information.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFErrorsTKey
OSIsoft.AFAFKeyedResultsTKey, TResult
OSIsoft.AFAFListResultsTKey, TResult
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
| Name | Description | |
|---|---|---|
| AFErrorsTKey | Initializes a new instance of the AFErrorsTKey class |
Properties
| Name | Description | |
|---|---|---|
| Errors | ||
| HasErrors |
Indicates if any errors were returned from the method.
| |
| PIServerErrors |
The dictionary of errors for a PIServer.
| |
| PISystemErrors |
The dictionary of errors for a PISystem.
|
Methods
| Name | Description | |
|---|---|---|
| AddError | ||
| AddPIServerError |
Add a PIServer specific error.
| |
| AddPISystemError |
Add a PISystem specific error.
| |
| 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.) |
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.