AFEnumerationSet.Remove Method (Guid)
- Last UpdatedSep 18, 2024
- PI System
- AF SDK 2024
- Developer
Removes the item with the specified id from the collection.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156
Syntax
public bool Remove( Guid id )
Public Function Remove ( id As Guid ) As Boolean Dim instance As AFEnumerationSet Dim id As Guid Dim returnValue As Boolean returnValue = instance.Remove(id)
public: bool Remove( Guid id )
member Remove : id : Guid -> bool
Parameters
- id
- Type: System.Guid
The id of the item to remove.
Return Value
Type: BooleanReturns true if the item is successfully removed; otherwise, false. This method also returns false if id was not found in the original collection.
Remarks
This method removes the item from the collection with the specified id. The id of the item is also removed from the lookup dictionary. This method approaches an O(1) operation.
If there is a need to delete many objects at once, it is better to delete them in bulk by using the delete method with a specified list of ids.