WindowsClaimsPrincipal.CreateFromWindowsIdentity Method (WindowsIdentity)

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

Returns a new instance of the WindowsClaimsPrincipal class initialized using the specified Windows identity.

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

Usage

'Usage
Dim identity As WindowsIdentity
Dim returnValue As IClaimsPrincipal

returnValue = WindowsClaimsPrincipal.CreateFromWindowsIdentity(identity)

Syntax

'Declaration
Public Shared Function CreateFromWindowsIdentity ( _
    identity As WindowsIdentity _
) As IClaimsPrincipal

public static IClaimsPrincipal CreateFromWindowsIdentity (
    WindowsIdentity identity
)

public:
static IClaimsPrincipal^ CreateFromWindowsIdentity (
    WindowsIdentity^ identity
)

public static IClaimsPrincipal CreateFromWindowsIdentity (
    WindowsIdentity identity
)

public static function CreateFromWindowsIdentity (
    identity : WindowsIdentity
) : IClaimsPrincipal

Parameters

identity
A WindowsIdentity that represents the user from which to create the new principal.

Return Value

An IClaimsPrincipal based on the specified user.

Exceptions

Exception type	Condition
ArgumentNullException	identity is null.

Remarks

Checks for anonymous identities and returns an AnonymousPrincipal object.

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