ClaimsPrincipal.SelectPrimaryIdentity Method

Article
10/05/2012

[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.]

Returns the primary identity from the specified collection of claims-based identities.

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

Usage

'Usage
Dim identities As ClaimsIdentityCollection
Dim returnValue As IClaimsIdentity

returnValue = ClaimsPrincipal.SelectPrimaryIdentity(identities)

Syntax

'Declaration
Public Shared Function SelectPrimaryIdentity ( _
    identities As ClaimsIdentityCollection _
) As IClaimsIdentity

public static IClaimsIdentity SelectPrimaryIdentity (
    ClaimsIdentityCollection identities
)

public:
static IClaimsIdentity^ SelectPrimaryIdentity (
    ClaimsIdentityCollection^ identities
)

public static IClaimsIdentity SelectPrimaryIdentity (
    ClaimsIdentityCollection identities
)

public static function SelectPrimaryIdentity (
    identities : ClaimsIdentityCollection
) : IClaimsIdentity

Parameters

identities
A ClaimsIdentityCollection that contains the claims-based identities.

Return Value

An IClaimsIdentity that represents the primary identity.

Exceptions

Exception type	Condition
ArgumentNullException	identities is null or empty.

Remarks

This method iterates through the IClaimsIdentity objects in the collection and determines which identity must be used as the primary one. If the collection contains a WindowsClaimsIdentity, it is the most preferred. If the collection contains an RsaClaimsIdentity, it is the least preferred.

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