IHttpUser::SupportsIsInRole Method

IHttpUser::SupportsIsInRole Method

IIS 7.0
 

Returns a value that indicates whether role support is enabled for the user.

virtual BOOL SupportsIsInRole(
   VOID
) = 0;

This method takes no parameters.

true if role support is enabled for the user; otherwise, false.

The SupportsIsInRole return value depends on implementation. You should use the following information as a guideline, but it may not be correct in all scenarios:

  • If the IHttpUser implementer handles managed or anonymous authentication, SupportsIsInRole returns true.

  • If the IHttpUser implementer implements Custom, Basic, Certification Mapping, or SSPI authentication, SupportsIsInRole returns false.

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.

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

<?xml version="1.0" ?>
<user supportsRoles="true" />

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 Windows Vista

  • IIS 7.5 on Windows 7

  • IIS 8.0 on Windows 8

  • IIS 10.0 on Windows 10

Server

  • IIS 7.0 on Windows Server 2008

  • 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 Technical Preview

Product

  • IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0

  • IIS Express 7.5, IIS Express 8.0, IIS Express 10.0

Header

Httpserv.h

Show:
© 2016 Microsoft