ClaimsPrincipal.CreateFromPrincipal Method (IPrincipal)

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

Creates the appropriate implementation of IClaimsPrincipal based on the type of the specified IPrincipal object or on the type of its underlying identity.

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

Usage

'Usage
Dim principal As IPrincipal
Dim returnValue As IClaimsPrincipal

returnValue = ClaimsPrincipal.CreateFromPrincipal(principal)

Syntax

'Declaration
Public Shared Function CreateFromPrincipal ( _
    principal As IPrincipal _
) As IClaimsPrincipal

public static IClaimsPrincipal CreateFromPrincipal (
    IPrincipal principal
)

public:
static IClaimsPrincipal^ CreateFromPrincipal (
    IPrincipal^ principal
)

public static IClaimsPrincipal CreateFromPrincipal (
    IPrincipal principal
)

public static function CreateFromPrincipal (
    principal : IPrincipal
) : IClaimsPrincipal

Parameters

principal
A IPrincipal that represents the principal from which to create the claims-based principal.

The DefaultIssuer is used for Windows claims.

Return Value

A IClaimsPrincipal object that represents the new claims-based principal.

Exceptions

Exception type	Condition
ArgumentNullException	identity is null.

Remarks

The implementation of the IClaimsPrincipal object returned is based on the type of the specified the IPrincipal object or on the type of the identity object returned by its Identity property; for example, a WindowsClaimsPrincipal is returned for a WindowsPrincipal.

Windows claims are associated with the DefaultIssuer.

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)