AF SDK Reference

AFDataCache.IsSuspendedSignupEnabled Property

Save PDF

AFDataCache.IsSuspendedSignupEnabled Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

If IsSuspendedSignupEnabled is set, the data pipe will suspend signups that are currently invalid but might become valid with changes outside of AF.

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

Syntax

public bool IsSuspendedSignupEnabled { get; set; }

Public Property IsSuspendedSignupEnabled As Boolean
	Get
	Set

Dim instance As AFDataCache
Dim value As Boolean

value = instance.IsSuspendedSignupEnabled

instance.IsSuspendedSignupEnabled = value

public:
property bool IsSuspendedSignupEnabled {
	bool get ();
	void set (bool value);
}

member IsSuspendedSignupEnabled : bool with get, set

Property Value

Type: Boolean

Remarks

IsSuspendedSignupEnabled can only be specified/changed before any AFAttributes are signed up in the datapipe. Attempts to set the IsSuspendedSignupEnabled after AddSignups/AddSignupsWithInitEvents calls will cause an InvalidOperationException.

Remarks

When this option is enabled, then updates that cannot currently be established but that could become valid without any changes to AF configuration can be left in a suspended state A common situation where this occur is an AFAttribute configured to monitor a PIPoint that does not exist. With this option enabled, attribute signups are retained in these situations and periodically retried. Suspended signups will report an AFDataPipeSignupSuspendedException on add but will not be unsubscribed. Periodic attempts to establish the signup will be made when data is updated and the first events will be sent with the special AFDataPipeSignupEstablishedEvent type. This option applies to inputs of calculations but no errors or special events are passed along for the calculation attribute.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5

AF SDK Reference