PIConnectFailedEventArgs Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Provides data for the ConnectFailed event.
Inheritance Hierarchy
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class PIConnectFailedEventArgs : AFEventArgs, IEquatable<PIConnectFailedEventArgs>
Public NotInheritable Class PIConnectFailedEventArgs Inherits AFEventArgs Implements IEquatable(Of PIConnectFailedEventArgs) Dim instance As PIConnectFailedEventArgs
public ref class PIConnectFailedEventArgs sealed : public AFEventArgs, IEquatable<PIConnectFailedEventArgs^>
[<SealedAttribute>] type PIConnectFailedEventArgs = class inherit AFEventArgs interface IEquatable<PIConnectFailedEventArgs> end
The PIConnectFailedEventArgs type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | PIConnectFailedEventArgs |
Initializes a new instance of the PIConnectFailedEventArgs class.
|
Properties
| Name | Description | |
|---|---|---|
 | AllowAutoPrompt |
This property is when a connection to a
PIServer fails when a login prompt would normally have been
displayed.
|
| Exception |
The PIConnectionException associated with the failed connection to the
PIServer.
|
| ID | (Overrides AFEventArgsID.) |
| PIServer |
The PIServer associated with this event.
|
Methods
| Name | Description | |
|---|---|---|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) |
| Equals(PIConnectFailedEventArgs) |
Indicates whether the current object is equal to another object of the same type.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
Operators
| Name | Description | |
|---|---|---|
  | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
Remarks
A ConnectFailed event is raised when a connection to
a PIServer fails when a login prompt would normally have been
displayed.