IHttpUser::SupportsIsInRole Method

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

Syntax

virtual BOOL SupportsIsInRole(  
   VOID  
) = 0;  

Parameters

This method takes no parameters.

Return Value

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

Remarks

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

See Also

IHttpUser Interface