IHttpModuleFactory::GetHttpModule (Método)

Crea una instancia de una clase CHttpModule .

Sintaxis

virtual HRESULT GetHttpModule(  
   OUT CHttpModule** ppModule,  
   IN IModuleAllocator* pAllocator  
) = 0;  

Parámetros

ppModule
[OUT] Puntero desreferenciado a una clase CHttpModule .

pAllocator
[IN] Puntero a una interfaz IModuleAllocator .

Valor devuelto

Una clase HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Valor	Descripción
S_OK	Indica que la operación se realizó correctamente.

Nota

Dado que el generador de módulos es necesario para proporcionar un GetHttpModule método, puede proporcionar cualquier código de estado para el valor devuelto según corresponda para la aplicación. Al menos, el GetHttpModule método debe devolver S_OK para indicar una finalización correcta.

Comentarios

Una interfaz IHttpModuleFactory debe proporcionar un GetHttpModule método que cree una instancia de la CHttpModule clase. Cuando IIS llama a la función RegisterModule exportada del módulo, IIS usará el método del generador de GetHttpModule módulos para crear una instancia de la CHttpModule clase.

Ejemplo

En el ejemplo de código siguiente se muestra cómo crear un módulo HTTP sencillo "Hola mundo". El módulo define una función exportada RegisterModule que pasa una instancia de una IHttpModuleFactory interfaz al método IHttpModuleRegistrationInfo::SetRequestNotifications y se registra para la notificación de RQ_BEGIN_REQUEST . IIS usa el GetHttpModule método para crear una instancia de una CHttpModule clase y devuelve un estado correcto. IIS también usa el método Terminate de la IHttpModuleFactory interfaz para quitar el generador de la memoria.

Cuando se desencadena una RQ_BEGIN_REQUEST notificación, IIS llama al método CHttpModule::OnBeginRequest del módulo para procesar la solicitud actual. OnBeginRequest borra el búfer de respuesta y modifica el tipo MIME de la respuesta. A continuación, el método crea un fragmento de datos que contiene una cadena "Hola mundo" y devuelve la cadena a un cliente web. Por último, el módulo devuelve un indicador de estado que notifica a IIS que todas las notificaciones finalizan y, a continuación, se cierran.

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

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

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Create a string with the response.
            PCSTR pszBuffer = "Hello World!";
            // Create a data chunk.
            HTTP_DATA_CHUNK dataChunk;
            // Set the chunk to a chunk in memory.
            dataChunk.DataChunkType = HttpDataChunkFromMemory;
            // Buffer for bytes written of data chunk.
            DWORD cbSent;
            
            // Set the chunk to the buffer.
            dataChunk.FromMemory.pBuffer =
                (PVOID) pszBuffer;
            // Set the chunk size to the buffer size.
            dataChunk.FromMemory.BufferLength =
                (USHORT) strlen(pszBuffer);
            // Insert the data chunk into the response.
            hr = pHttpResponse->WriteEntityChunks(
                &dataChunk,1,FALSE,TRUE,&cbSent);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the HTTP status.
                pHttpResponse->SetStatus(500,"Server Error",0,hr);
            }

            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// Create the module's class factory.
class CHelloWorldFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

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

        // 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 CHelloWorldFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

El módulo debe exportar la RegisterModule función. Puede exportar esta función mediante la creación de un archivo de definición de módulo (.def) para el proyecto, o bien puede compilar el módulo mediante el /EXPORT:RegisterModule modificador . Para obtener más información, vea Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo.

Opcionalmente, puede compilar el código mediante la __stdcall (/Gz) convención de llamada en lugar de declarar explícitamente la convención de llamada para cada función.

Requisitos

Tipo	Descripción
Remoto	- IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10
Servidor	- IIS 7.0 en Windows Server 2008 - IIS 7.5 en Windows Server 2008 R2 - IIS 8.0 en Windows Server 2012 - IIS 8.5 en Windows Server 2012 R2 - IIS 10.0 en Windows Server 2016
Producto	- 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
Encabezado	Httpserv.h

Consulte también

CHttpModule (clase)
IHttpModuleFactory (Interfaz)
Diseño de módulos HTTP de Native-Code
Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo