PFN_REGISTERMODULE 함수

아티클
07/19/2023

네이 RegisterModule 티브 코드 HTTP 모듈에 대한 함수 프로토타입을 정의합니다.

구문

typedef HRESULT(WINAPI* PFN_REGISTERMODULE)(  
   DWORD dwServerVersion,  
   IHttpModuleRegistrationInfo* pModuleInfo,  
   IHttpServer* pGlobalInfo  
);

매개 변수

dwServerVersion
DWORD IIS 주 버전 번호가 포함된 입니다.

pModuleInfo
IHttpModuleRegistrationInfo 인터페이스에 대한 포인터입니다.

pGlobalInfo
IHttpServer 인터페이스에 대한 포인터입니다.

반환 값

HRESULT입니다. 가능한 값에는 다음 표에 있는 값이 포함되지만, 이에 국한되는 것은 아닙니다.

값	설명
S_OK	작업이 성공했음을 나타냅니다.

참고

모듈은 유효한 HRESULT 값을 반환할 수 있지만 함수가 성공했음을 나타내 RegisterModule 기 위해 최소 S_OK 반환해야 합니다.

설명

PFN_REGISTERMODULE 는 모든 HTTP 모듈이 DLL 진입점에 대해 구현하는 데 필요한 함수의 함수 프로토타입 RegisterModule 입니다.

HTTP 모듈을 만들 때 모듈은 다음 RegisterModule 메서드를 추가해야 합니다.

HRESULT RegisterModule(  
   DWORD dwServerVersion,  
   IHttpModuleRegistrationInfo* pModuleInfo,  
   IHttpServer* pGlobalInfo  
)

IIS가 모듈을 로드하려면 모든 HTTP 모듈이 함수를 내보내 RegisterModule 야 합니다. DLL 프로젝트에 대한 모듈 정의(.def) 파일을 만들거나 스위치를 사용하여 모듈을 컴파일하여 함수를 /EXPORT:RegisterModule 내 RegisterModule 보낼 수 있습니다.

RegisterModule 함수는 SetRequestNotifications 및 SetGlobalNotifications 메서드를 사용하여 알림을 등록하기 위해 인터페이스를 사용해야 IHttpModuleRegistrationInfo 합니다. RegisterModule또한 SetPriorityForRequestNotification 및 SetPriorityForGlobalNotification 메서드를 사용하여 모듈 우선 순위를 등록하는 데 를 사용해야 IHttpModuleRegistrationInfo 합니다.

매개 변수에는 dwServerVersion 모듈을 로드하는 IIS 버전의 주 버전 번호가 포함되어 있습니다. 예를 들어 IIS 7.0의 경우 매개 변수에는 dwServerVersion 7이 포함됩니다.

IIS는 함수를 호출할 RegisterModule 때 모듈이 IHttpServer 서버 수준 정보를 검색하는 데 사용할 수 있는 인터페이스를 제공합니다.

참고

함수 구현 내에서 RegisterModule 추적 이벤트를 발생시키지 않아야 합니다(IHttpTraceContext::QuickTrace 메서드 또는 IHttpServer::GetTraceContext 메서드를 통해 다른 수단을 통해). RegisterModule 내에서 추적 이벤트를 발생시키는 경우 요청 파이프라인에서 너무 일찍 액세스 위반이 발생할 수 있습니다.

예제

다음 코드 예제에서는 간단한 "헬로 월드" HTTP 모듈을 만드는 방법을 보여 줍니다. 이 모듈은 IHttpModuleFactory 인터페이스의 instance IHttpModuleRegistrationInfo::SetRequestNotifications 메서드에 전달하고 RQ_BEGIN_REQUEST 알림에 등록하는 내 RegisterModule 보낸 함수를 정의합니다. IIS는 IHttpModuleFactory::GetHttpModule 메서드를 사용하여 CHttpModule 클래스의 instance 만들고 성공 상태 반환합니다. 또한 IIS는 IHttpModuleFactory::Terminate 메서드를 사용하여 메모리에서 팩터리를 제거합니다.

알림이 RQ_BEGIN_REQUEST 발생하면 IIS는 모듈의 CHttpModule::OnBeginRequest 메서드를 호출하여 현재 요청을 처리합니다. OnBeginRequest 는 응답 버퍼를 지우고 응답에 대한 MIME 형식을 수정합니다. 그런 다음 메서드는 "헬로 월드" 문자열을 포함하는 데이터 청크를 만들고 문자열을 웹 클라이언트에 반환합니다. 마지막으로 모듈은 IIS에 모든 알림이 완료된 후 종료됨을 알리는 상태 표시기를 반환합니다.

#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
    );
}

모듈은 함수를 RegisterModule 내보내야 합니다. 프로젝트에 대한 모듈 정의(.def) 파일을 만들어 이 함수를 내보내거나 스위치를 사용하여 /EXPORT:RegisterModule 모듈을 컴파일할 수 있습니다. 자세한 내용은 연습: 네이티브 코드를 사용하여 Request-Level HTTP 모듈 만들기를 참조하세요.

필요에 따라 각 함수에 대한 호출 규칙을 명시적으로 선언하는 대신 호출 규칙을 사용하여 __stdcall (/Gz) 코드를 컴파일할 수 있습니다.

요구 사항

형식	Description
클라이언트	- Windows Vista의 IIS 7.0 - Windows 7의 IIS 7.5 - Windows 8의 IIS 8.0 - WINDOWS 10 IIS 10.0
서버	- Windows Server 2008의 IIS 7.0 - Windows Server 2008 R2의 IIS 7.5 - Windows Server 2012의 IIS 8.0 - Windows Server 2012 R2의 IIS 8.5 - WINDOWS SERVER 2016 IIS 10.0
제품	- 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
헤더	Httpserv.h

참고 항목

IHttpModuleRegistrationInfo 인터페이스
IHttpModuleRegistrationInfo::SetGlobalNotifications 메서드
IHttpModuleRegistrationInfo::SetPriorityForGlobalNotification 메서드
IHttpModuleRegistrationInfo::SetPriorityForRequestNotification 메서드
IHttpModuleRegistrationInfo::SetRequestNotifications 메서드
IHttpServer 인터페이스

다음을 통해 공유

PFN_REGISTERMODULE 함수

구문

매개 변수

반환 값

설명

예제

요구 사항

참고 항목

피드백

추가 리소스