PIAuthenticationException Class
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
Represents an authentication error returned from the PIServer.
Inheritance Hierarchy
SystemObject
SystemException
SystemSystemException
System.ServiceModelCommunicationException
OSIsoft.AF.PIPIConnectionException
OSIsoft.AF.PIPIAuthenticationException
SystemException
SystemSystemException
System.ServiceModelCommunicationException
OSIsoft.AF.PIPIConnectionException
OSIsoft.AF.PIPIAuthenticationException
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public sealed class PIAuthenticationException : PIConnectionException
<SerializableAttribute> Public NotInheritable Class PIAuthenticationException Inherits PIConnectionException Dim instance As PIAuthenticationException
[SerializableAttribute] public ref class PIAuthenticationException sealed : public PIConnectionException
[<SealedAttribute>] [<SerializableAttribute>] type PIAuthenticationException = class inherit PIConnectionException end
The PIAuthenticationException type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PIAuthenticationException |
Initializes a new instance of the PIAuthenticationException class with a
specified error message and a reference to the inner exception that is the cause
of this exception.
|
Properties
| Name | Description | |
|---|---|---|
 | Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.) |
| 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.) |
| IsSecurityException |
Indicates if the error indicates the user did not connect due to insufficient privileges.
(Inherited from PIConnectionException.) |
| Message | Gets a message that describes the current exception. (Inherited from Exception.) |
| Reason |
The information for why the authentication failed when connecting to the PIServer.
|
| Server |
The PIServer associated with the current exception.
(Inherited from PIConnectionException.) |
| 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.) |
| StatusCode |
The status code indicating the cause of the current exception that was returned
from the PIServer.
(Inherited from PIConnectionException.) |
| 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 PIConnectionExceptionGetObjectData(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.) |