.NET Framework Class Library
HostingEnvironment.Impersonate Method (IntPtr, String)
Impersonates the user specified by the configuration settings for the specified virtual path, or the specified user token.
Assembly: System.Web (in System.Web.dll)
Syntax
Visual Basic
<SecurityPermissionAttribute(SecurityAction.Demand, Unrestricted := True)> _ Public Shared Function Impersonate ( _ userToken As IntPtr, _ virtualPath As String _ ) As IDisposable
C#
[SecurityPermissionAttribute(SecurityAction.Demand, Unrestricted = true)] public static IDisposable Impersonate( IntPtr userToken, string virtualPath )
Visual C++
[SecurityPermissionAttribute(SecurityAction::Demand, Unrestricted = true)] public: static IDisposable^ Impersonate( IntPtr userToken, String^ virtualPath )
F#
[<SecurityPermissionAttribute(SecurityAction.Demand, Unrestricted = true)>] static member Impersonate : userToken:IntPtr * virtualPath:string -> IDisposable
Parameters
- userToken
- Type: System.IntPtr
The handle of a Windows account token.
- virtualPath
- Type: System.String
The path to the requested resource.
Return Value
Type: System.IDisposableAn IDisposable object that represents the Windows user prior to impersonation; this object can be used to revert to the original user's context.
Exceptions
| Exception | Condition |
|---|---|
| HttpException |
The process cannot impersonate. |
Remarks
The Impersonate method impersonates the user that results after applying all identity elements in the configuration settings affecting the specified virtual path. If an identity element is not specified for the virtual path, the Impersonate method impersonates the specified Windows account.
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also