Skip to content

ihttpuser-getimpersonationtoken-method.md

Latest commit

 

History

History
59 lines (43 loc) · 4.02 KB

ihttpuser-getimpersonationtoken-method.md

File metadata and controls

59 lines (43 loc) · 4.02 KB
title IHttpUser::GetImpersonationToken Method
description IHttpUser::GetImpersonationToken Method returns the user impersonation token.
ms.date 10/07/2016
ms.assetid 25f33eb6-64ac-aae2-92fe-8d4e03a1142e

IHttpUser::GetImpersonationToken Method

Returns the user impersonation token.

Syntax

virtual HANDLE GetImpersonationToken(  
   VOID  
) = 0;

Parameters

This method takes no parameters.

Return Value

A HANDLE that represents the impersonation token for the user; otherwise, NULL.

Remarks

The SupportsIsInRole and IsInRole methods return FALSE and E_NOTIMPL, respectively, from the default implementation. Therefore, use the handle that is returned from either the GetImpersonationToken or GetPrimaryToken method for role-based authorization.

Notes for Implementers

IHttpUser implementers are responsible for resource management with this data; therefore, IHttpUser implementers must call CloseHandle on the handle when it is no longer needed.

Notes for Callers

IHttpUser implementers are responsible for resource management with this data; therefore, IHttpUser clients must not call CloseHandle on the returned handle when this data is no longer needed. Furthermore, clients must not change the state of the memory referenced by this handle, because an access violation will be thrown or the data will become invalid.

Example

The following code example demonstrates how to create an HTTP module that clears the response headers and body and then returns user information to the client as an XML document.

[!code-cppIHttpUser#3]

The above code writes XML that is similar to the following to the response stream.

<?xml version="1.0" ?>  
<user impersonationToken="valid" />

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IHttpUser Interface