AFDataPipeSignupSuspendedException Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Represents a signup that cannot be completed currently but could become active in the future.
Inheritance Hierarchy
SystemObject
SystemException
OSIsoft.AF.DataAFDataPipeSignupSuspendedException
SystemException
OSIsoft.AF.DataAFDataPipeSignupSuspendedException
Namespace: OSIsoft.AF.Data
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public class AFDataPipeSignupSuspendedException : Exception, ISerializable
<SerializableAttribute> Public Class AFDataPipeSignupSuspendedException Inherits Exception Implements ISerializable Dim instance As AFDataPipeSignupSuspendedException
[SerializableAttribute] public ref class AFDataPipeSignupSuspendedException : public Exception, ISerializable
[<SerializableAttribute>] type AFDataPipeSignupSuspendedException = class inherit Exception interface ISerializable end
The AFDataPipeSignupSuspendedException type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFDataPipeSignupSuspendedException |
Construct a suspended signup exception.
|
| AFDataPipeSignupSuspendedException(String) |
Construct a suspended signup exception.
|
| AFDataPipeSignupSuspendedException(String, Exception) |
Construct a suspended signup 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.) |
| 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 | When overridden in a derived class, sets the SerializationInfo with information about the exception. (Inherited from Exception.) |
| 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
If the IsSuspendedSignupEnabled or IsSuspendedSignupEnabled options are enabled
then attribute signups that are suspended are indicated by an AFDataPipeSignupSuspendedException error returned in the signup call.
It is not guaranteed that the signup will be established immediately when it is available, but it should be picked up within 10 minutes.
If the PIPointCacheUpdatePeriod is set to a positive value, updates can be processed more promptly in some cases.
When the signup is establshied and data start, an AFDataPipeSignupEstablishedEvent will be sent on the first update scan that the signup receives data.