Click or drag to resize
OSIsoft, LLC

PIConnectionException Class

Represents a connection error attempting to communicate with the specified PIServer.

Inheritance Hierarchy

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
[SerializableAttribute]
public class PIConnectionException : CommunicationException

The PIConnectionException type exposes the following members.

Constructors
  NameDescription
Public methodPIConnectionException
Initializes a new instance of the PIConnectionException class with a specified error message, server host address, and an optional reference to the inner exception that is the cause of this exception.
Top
Properties
  NameDescription
Public propertyData
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception.)
Public propertyHelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
Public propertyHResult
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception.)
Public propertyInnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Public propertyIsSecurityException
Indicates if the error indicates the user did not connect due to insufficient privileges.
Public propertyMessage
Gets a message that describes the current exception.
(Inherited from Exception.)
Public propertyServer
The PIServer associated with the current exception.
Public propertySource
Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception.)
Public propertyStackTrace
Gets a string representation of the immediate frames on the call stack.
(Inherited from Exception.)
Public propertyStatusCode
The status code indicating the cause of the current exception that was returned from the PIServer.
Public propertyTargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetBaseException
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides ExceptionGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the runtime type of the current instance.
(Inherited from Exception.)
Public methodToString
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Top
Extension Methods
  NameDescription
Public Extension MethodIsRetryable
This extension method will indicate if the Exception is considered retryable.
(Defined by AFSDKExtension.)
Top
Remarks
Robust client and service applications handle CommunicationException objects that may be thrown during communication. There are also two CommunicationException-derived exception types, PIAuthenticationException and PITimeoutException that clients also often expect. Therefore, in order to prevent the generic CommunicationException handler from catching these more specific exception types, catch these exceptions prior to handling CommunicationException.
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence