IHttpRequest::GetRawHttpRequest Method

Article
03/09/2018

Returns a structure that contains the raw HTTP request.

Syntax

virtual HTTP_REQUEST* GetRawHttpRequest(  
   VOID  
) = 0;

Parameters

This method takes no parameters.

Return Value

A pointer to an HTTP_REQUEST structure.

Remarks

The GetRawHttpRequest method retrieves the raw request and returns a pointer to an HTTP_REQUEST structure that contains the current request entity.

Note

The HTTP_REQUEST structure is defined in the Http.h file.

The lifetime of this structure is controlled by the server, and the structure is available until the end of the request.

Example

The following code example demonstrates how to use the GetRawHttpRequest method to create an HTTP module that retrieves the HTTP_REQUEST structure for the current request. The code example then shows how to use the structure to retrieve the HTTP verb, HTTP major version, and HTTP minor version for the request.

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Retrieve a pointer to the request.
        IHttpRequest * pHttpRequest = pHttpContext->GetRequest();

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Return the raw HTTP_REQUEST structure. (Defined in the Http.h file.)
            HTTP_REQUEST * pRawRequest = pHttpRequest->GetRawHttpRequest();
            // Test for an error.
            if (pRawRequest != NULL)
            {
                // Retrieve the ID of the HTTP verb.
                // (From the HTTP_VERB enumeration defined in the Http.h file.)
                long HttpVerb = pRawRequest->Verb;
                // Retrieve the HTTP version.
                // (From the HTTP_VERSION structure defined in the Http.h file.)
                USHORT HttpMajorVersion = pRawRequest->Version.MajorVersion;
                USHORT HttpMinorVersion = pRawRequest->Version.MinorVersion;
            }
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};
// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

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

Share via