IHttpContext::MapHandler Method

IHttpContext::MapHandler Method

IIS 7.0

Maps a handler for the specified URL and HTTP verb on a site.

virtual HRESULT MapHandler(
    DWORD               dwSiteId,
    PCWSTR              pszSiteName,
    PCWSTR              pszUrl,
    PCSTR               pszVerb,
    IScriptMapInfo **   ppScriptMap,
    BOOL                fIgnoreWildcardMappings
) = 0;

dwSiteId

[IN] The ID of the site that contains the URL for mapping.

pszSiteName

[IN] A pointer to a string that contains the site name for the target URL.

pszUrl

[IN] A pointer to a string that contains the relative URL for mapping.

pszVerb

[IN] A pointer to a string that contains the HTTP verb for mapping.

ppScriptMap

[OUT] A pointer to the IScriptMapInfo interface that contains details for the selected script map.

fIgnoreWildcardMappings

[IN] true to ignore wildcard mapping; otherwise, false.

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value

Description

S_OK

Indicates that the operation was successful.

ERROR_NOT_ENOUGH_MEMORY

Indicates that there is insufficient memory to perform the operation.

The IScriptMapInfo interface is valid to use for the lifetime of the IHttpContext interface.

The following code example demonstrates how to use the MapHandler method to create an HTTP module that returns.

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 compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Type

Description

Client

  • IIS 7.0 on Windows Vista

  • IIS 7.5 on Windows 7

  • IIS Express 7.5 on Windows XP, Windows Vista, Windows 7

  • IIS 8.0 on Windows 8 Client

Server

  • IIS 7.0 on Windows Server 2008

  • IIS 7.5 on Windows Server 2008 R2

  • IIS Express 7.5 on Windows Server 2003, Windows Server 2008, Windows Server 2008 R2

  • IIS 8.0 on Windows 8 Server

Product

IIS 7.0, IIS 7.5, IIS Express 7.5, IIS 8.0

Header

Httpserv.h

Community Additions

ADD
Show:
© 2016 Microsoft