AF SDK Reference

PIException Class

Save PDF

TABLE OF CONTENTS

PIException Class

Save PDF

Last UpdatedNov 18, 2025
5 minute read

PIException Class

Represents an error returned from the PIServer.

Inheritance Hierarchy

SystemObject
  SystemException
    OSIsoft.AF.PIPIException
      OSIsoft.AF.PIPIBufferException
      OSIsoft.AF.PIPIConfigurationException
      OSIsoft.AF.PIPIPointInvalidException
      OSIsoft.AF.PIPISerializationException
      OSIsoft.AF.PIPIVersionNotSupportedException

Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

[SerializableAttribute]
public class PIException : Exception, 
	ISerializable

<SerializableAttribute>
Public Class PIException
	Inherits Exception
	Implements ISerializable

Dim instance As PIException

[SerializableAttribute]
public ref class PIException : public Exception, 
	ISerializable

[<SerializableAttribute>]
type PIException =  
    class
        inherit Exception
        interface ISerializable
    end

The PIException type exposes the following members.

Constructors

	Name	Description
	PIException	Initializes a new instance of the PIException class with a specified error message, status code, 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.)
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	Server	The PIServer associated with the current exception.
	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.
	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.)

Remarks

This class is the base class for all PI exceptions. When an error occurs, either the system or the currently executing application reports it by throwing an exception containing information about the error. Once thrown, an exception is handled by the application or by the default exception handler.

AF SDK Reference