AFAnalysisException Class
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
AFAanlysisException Class
used for analysis errors and warnings during configuration or run time
Inheritance Hierarchy
SystemObject
SystemException
OSIsoft.AF.AnalysisAFAnalysisException
SystemException
OSIsoft.AF.AnalysisAFAnalysisException
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public class AFAnalysisException : Exception
<SerializableAttribute> Public Class AFAnalysisException Inherits Exception Dim instance As AFAnalysisException
[SerializableAttribute] public ref class AFAnalysisException : public Exception
[<SerializableAttribute>] type AFAnalysisException = class inherit Exception end
The AFAnalysisException type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFAnalysisException |
Default constructor
|
| AFAnalysisException(String) |
Constructor
|
| AFAnalysisException(String, AFAnalysisErrorSeverity) |
Constructor
|
| AFAnalysisException(String, Exception) |
Constructor
|
| AFAnalysisException(Int32, IAFLocalizedErrorProvider, String) |
Constructor
|
| AFAnalysisException(Int32, String, String) |
Constructor
|
| AFAnalysisException(String, Exception, AFAnalysisErrorSeverity) |
Constructor
|
| AFAnalysisException(Int32, IAFLocalizedErrorProvider, AFAnalysisErrorSeverity, String) |
Constructor
|
| AFAnalysisException(Int32, IAFLocalizedErrorProvider, Exception, String) |
Constructor
|
| AFAnalysisException(Int32, String, AFAnalysisErrorSeverity, String) |
Constructor
|
| AFAnalysisException(Int32, IAFLocalizedErrorProvider, AFAnalysisErrorSeverity, Exception, String) |
Constructor
|
Properties
| Name | Description | |
|---|---|---|
 | Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
| ErrorCode |
Error code for to generate localized message
|
| ErrorStringArg |
supports formatting of error strings e.g. "Incorrect index type (Input) for {0}.", PELexClass.tokenToString(_operationType)
if supplied then an attempt will be made in message construction to format the string
|
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception.) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception.) |
| IsSdkError |
Indicates whether the error was set by AF SDK
|
| Message |
Message
(Overrides ExceptionMessage.) |
| Severity |
AnalysisErrorSeverity
|
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.) |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception.) |
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | Obsolete.
Populates a SerializationInfo with the data needed to serialize
the target object.
(Overrides ExceptionGetObjectData(SerializationInfo, StreamingContext).) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception.) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception.) |
Extension Methods
| Name | Description | |
|---|---|---|
 | IsRetryable |
This extension method will indicate if the Exception
is considered retryable.
(Defined by AFSDKExtension.) |