AF SDK Reference

PIIdentityMappings.Remove Method (PIIdentityMapping)

Save PDF

TABLE OF CONTENTS

PIIdentityMappings.Remove Method (PIIdentityMapping)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Removes a PIIdentityMapping from the PI Data Archive

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

Syntax

public bool Remove(
	PIIdentityMapping item
)

Public Function Remove ( 
	item As PIIdentityMapping
) As Boolean

Dim instance As PIIdentityMappings
Dim item As PIIdentityMapping
Dim returnValue As Boolean

returnValue = instance.Remove(item)

public:
bool Remove(
	PIIdentityMapping^ item
)

member Remove : 
        item : PIIdentityMapping -> bool

Parameters

item: Type: OSIsoft.AF.PIPIIdentityMapping
The PIIdentityMapping to delete.

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 item is .

Remarks

The PIIdentityMapping 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

AF SDK Reference