AFCollective.Delete Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Delete the collective by removing all members from the collective.
Namespace: OSIsoft.AF.Collective
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public void Delete( bool continueOnError, EventHandler<AFProgressEventArgs> eventHandler )
Public Sub Delete ( continueOnError As Boolean, eventHandler As EventHandler(Of AFProgressEventArgs) ) Dim instance As AFCollective Dim continueOnError As Boolean Dim eventHandler As EventHandler(Of AFProgressEventArgs) instance.Delete(continueOnError, eventHandler)
public: void Delete( bool continueOnError, EventHandler<AFProgressEventArgs^>^ eventHandler )
member Delete : continueOnError : bool * eventHandler : EventHandler<AFProgressEventArgs> -> unit
Parameters
- continueOnError
- Type: SystemBoolean
If , the deletion of the collective will stop on the first error. If , the deletion of the collective will continue on an error and update all collective members that are accessible. This parameter would normally only be set to when the Primary collective member is not available and is not expected to be available in the future. - eventHandler
- Type: SystemEventHandlerAFProgressEventArgs
Delegate used to receive progress indication on operation. If , then any errors saving changes to the primary member will generate an exception and to the secondary members will be ignored.
Remarks
All members will be removed from the collective and the collective will
be deleted.