IHttpModuleRegistrationInfo：：SetRequestNotifications 方法

註冊模組的要求層級通知。

語法

virtual HRESULT SetRequestNotifications(  
   IN IHttpModuleFactory* pModuleFactory,  
   IN DWORD dwRequestNotifications,  
   IN DWORD dwPostRequestNotifications  
) = 0;  

參數

pModuleFactory
[IN] IHttpModuleFactory 介面的指標。

dwRequestNotifications
[IN]位元遮罩值，其中包含要註冊的要求通知。 在 Httpserv.h.) 中定義的 (

dwPostRequestNotifications
[IN]位元遮罩值，其中包含要註冊的事件後通知。 (在 Httpserv.h.) 中定義

傳回值

HRESULT。 可能的值包括 (但不限於) 下表中的這些值。

備註

方法 SetRequestNotifications 會註冊 CHttpModule 類別的要求層級通知。 模組可以註冊每個通知的兩個事件：事件通知，如 參數中的 dwRequestNotifications 位元遮罩所指示，以及事件後通知，如 參數中的 dwPostRequestNotifications 位元遮罩所指示。

例如，HTTP 模組可以註冊 RQ_AUTHENTICATE_REQUEST 通知，以及該相同通知的事件後通知。 如此一來，模組可以提供事件通知的額外處理功能，並清除事件後通知中的任何處理詳細資料。

方法 SetRequestNotifications 需要 IHttpModuleFactory 介面的指標，IIS 將用來建立類別的 CHttpModule 實例。 如果無法建立類別， CHttpModule 此處理站必須處理類別的建立實例，並傳回任何錯誤訊息。

範例

下列範例示範如何建立使用 RegisterModule 函式的 HTTP 模組，以及下列方法來註冊全域層級和要求層級通知的模組。

• 方法 SetRequestNotifications 會 CHttpModule 註冊要求層級 OnBeginRequest 通知的類別。

• SetPriorityForRequestNotification方法會設定要求層級通知的模組優先順序。

• SetGlobalNotifications方法會註冊全域層級OnGlobalPreBeginRequest通知的CGlobalModule類別。

• SetPriorityForGlobalNotification方法會設定模組全域層級通知的優先順序。

  模組會回應已註冊的通知，並將專案寫入事件檢視器中的應用程式記錄檔。

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

// Create a global handle for the Event Viewer.
HANDLE g_hEventLog;

// Define the method that writes to the Event Viewer.
BOOL WriteEventViewerLog(LPCSTR szBuffer[], WORD wNumStrings);

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

        // Create an array of strings.
        LPCSTR szBuffer[2] = {"MyHttpModule","OnBeginRequest"};
        // Write the strings to the Event Viewer.
        WriteEventViewerLog(szBuffer,2);

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

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalPreBeginRequest(
        IN IPreBeginRequestProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        
        // Create an array of strings.
        LPCSTR szBuffer[2] = {"MyGlobalModule","OnGlobalPreBeginRequest"};
        // Write the strings to the Event Viewer.
        WriteEventViewerLog(szBuffer,2);

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

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

    MyGlobalModule()
    {
        // Open a handle to the Event Viewer.
        g_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyGlobalModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != g_hEventLog)
        {
            DeregisterEventSource( g_hEventLog );
            g_hEventLog = NULL;
        }
    }
};

// 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;
    }
};

// Define a method that writes to the Event Viewer.
BOOL WriteEventViewerLog(LPCSTR szBuffer[], WORD wNumStrings)
{
    // Test whether the handle for the Event Viewer is open.
    if (NULL != g_hEventLog)
    {
        // Write any strings to the Event Viewer and return.
        return ReportEvent(
            g_hEventLog,
            EVENTLOG_INFORMATION_TYPE,
            0, 0, NULL, wNumStrings,
            0, szBuffer, NULL );
    }
    return FALSE;
}

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

    // Create an HRESULT to receive return values from methods.
    HRESULT hr;

    // Set the request notifications.
    hr = pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST, 0 );

    // Test for an error and exit if necessary.
    if (FAILED(hr))
    {
        return hr;
    }

    // Set the request priority.
    hr = pModuleInfo->SetPriorityForRequestNotification(
        RQ_BEGIN_REQUEST,PRIORITY_ALIAS_MEDIUM);

    // Test for an error and exit if necessary.
    if (FAILED(hr))
    {
        return hr;
    }

    // Create an instance of the global module class.
    MyGlobalModule * pGlobalModule = new MyGlobalModule;
 
    // Test for an error.
    if (NULL == pGlobalModule)
    {
        return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
    }
 
    // Set the global notifications.
    hr = pModuleInfo->SetGlobalNotifications(
        pGlobalModule, GL_PRE_BEGIN_REQUEST );

    // Test for an error and exit if necessary.
    if (FAILED(hr))
    {
        return hr;
    }

    // Set the global priority.
    hr = pModuleInfo->SetPriorityForGlobalNotification(
        GL_PRE_BEGIN_REQUEST,PRIORITY_ALIAS_LOW);

    // Test for an error and exit if necessary.
    if (FAILED(hr))
    {
        return hr;
    }

    // Return a success status;
    return S_OK;
}

您的模組必須匯出函 RegisterModule 式。 您可以為專案建立模組定義 (.def) 檔案，或使用 參數編譯模組 /EXPORT:RegisterModule 來匯出此函式。 如需詳細資訊，請參閱 逐步解說：使用機器碼建立 Request-Level HTTP 模組。

您可以選擇性地使用呼叫慣例編譯器代碼， __stdcall (/Gz) 而不是明確宣告每個函式的呼叫慣例。

規格需求

另請參閱

IHttpModuleRegistrationInfo 介面
IHttpModuleRegistrationInfo：：SetGlobalNotifications 方法
IHttpModuleRegistrationInfo：：SetPriorityForGlobalNotification 方法
IHttpModuleRegistrationInfo：：SetPriorityForRequestNotification 方法
PFN_REGISTERMODULE函式