AF SDK Reference

PIStateSets.Remove Method (String)

Save PDF

TABLE OF CONTENTS

PIStateSets.Remove Method (String)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Removes a PI Digital State Set from the PI Data Archive by name

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

Syntax

public bool Remove(
	string name
)

Public Function Remove ( 
	name As String
) As Boolean

Dim instance As PIStateSets
Dim name As String
Dim returnValue As Boolean

returnValue = instance.Remove(name)

public:
bool Remove(
	String^ name
)

member Remove : 
        name : string -> bool

Parameters

name: Type: SystemString
The name of the set.

Return Value

Type: Boolean
if the item is successfully removed; otherwise, . This method also returns if name was not found in the original collection.

Exceptions

Exception	Condition
ArgumentNullException	If name is or empty.

Remarks

The set is immediately deleted from the PI Data Archive.

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, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

AF SDK Reference