PIServers.Remove Method (String)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Unregisters an existing PIServer with the specified 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 PIServers 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 local name of the PIServer to be unregistered.
Return Value
Type: BooleanReturns if the item is successfully removed; otherwise, . This method also returns if name was not found in the original collection.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | This exception is thrown if an attempt is made to remove the last PIServer in the list. |
Remarks
This method is used to unregister an existing PIServer entry from the list of
known PI Data Archive servers on the local machine. This does not affect the configuration
of servers on other client computers.
 Important |
|---|
| The last PIServer in the list is not allowed to be removed. |