ClaimCollection.Remove Method

Article
2012-10-05

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Removes a claim from the ClaimCollection.

Namespace: Microsoft.IdentityModel.Claims
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As ClaimCollection
Dim item As Claim
Dim returnValue As Boolean

returnValue = instance.Remove(item)

Syntax

'Declaration
Public Function Remove ( _
    item As Claim _
) As Boolean

public bool Remove (
    Claim item
)

public:
virtual bool Remove (
    Claim^ item
) sealed

public final boolean Remove (
    Claim item
)

public final function Remove (
    item : Claim
) : boolean

Parameters

item
The Claim to remove.

Return Value

true if the claim was removed; otherwise, false.

Exceptions

Exception type	Condition
ArgumentNullException	item is null.
InvalidOperationException	The Subject of item is not the same as the subject associated with this ClaimCollection. -or- item does not exist in this ClaimCollection.

ArgumentNullException

item is null.

InvalidOperationException

The Subject of item is not the same as the subject associated with this ClaimCollection.

-or-

item does not exist in this ClaimCollection.

Remarks

The Subject property of the Claim removed from the ClaimCollection is set to null.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Share via