GLOBAL_NOTIFICATION_STATUS列挙
グローバル レベルの通知の戻り値を定義します。
構文
typedef enum GLOBAL_NOTIFICATION_STATUS{
GL_NOTIFICATION_CONTINUE,
GL_NOTIFICATION_HANDLED
};
メンバー
| メンバー名 | 説明 |
|---|---|
GL_NOTIFICATION_CONTINUE |
IIS が追加のグローバル レベルの通知の処理を続行する必要があることを示します。 |
GL_NOTIFICATION_HANDLED |
IIS がグローバル レベルの通知の処理を完了し、追加のグローバル レベルの通知を処理しないことを示します。 |
解説
列挙体の GLOBAL_NOTIFICATION_STATUS メンバーはグローバル レベルの通知からの戻り値として使用され、メンバーはグローバル レベルの通知処理パイプライン内のプロセス フローを制御するのに役立ちます。 たとえば、グローバル レベルの通知ハンドラーから戻る GL_NOTIFICATION_CONTINUE 場合は、追加のグローバル レベルの通知の処理を続行するように IIS に指示します。一方、グローバル レベルの通知ハンドラーからを返す GL_NOTIFICATION_HANDLED 場合は、グローバル レベルの処理が完了し、IIS は追加のグローバル レベルの通知を処理しないことを IIS に通知します。
例
次のコード例は、単純な "Hello World" グローバル レベルの HTTP モジュールを作成する方法を示しています。 モジュールは、CGlobalModule から派生したクラスのインスタンスを作成するエクスポートされた RegisterModule 関数を定義します。 クラスを作成できない場合、関数はエラー コードで終了します。それ以外の場合、関数は IHttpModuleRegistrationInfo::SetRequestNotifications メソッドを呼び出して 、GL_PRE_BEGIN_REQUEST 通知に登録します。
通知が GL_PRE_BEGIN_REQUEST 発生すると、IIS はモジュールの CGlobalModule::OnGlobalPreBeginRequest メソッドを呼び出して通知を処理します。 メソッドはプライベート メソッドを呼び出して、イベント ビューアーのアプリケーション ログにイベントを書き込んだ後、 を返GL_NOTIFICATION_CONTINUEして IIS に通知し、他の通知の処理を続行します。 処理が完了すると、IIS はモジュールの CGlobalModule::Terminate メソッドを呼び出して、 クラスをメモリから削除します。
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
// Process a GL_APPLICATION_START notification.
GLOBAL_NOTIFICATION_STATUS
OnGlobalPreBeginRequest(
IN IPreBeginRequestProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
WriteEventViewerLog( "Hello World!" );
return GL_NOTIFICATION_CONTINUE;
}
VOID Terminate()
{
// Remove the class from memory.
delete this;
}
MyGlobalModule()
{
// Open a handle to the Event Viewer.
m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
}
~MyGlobalModule()
{
// Test whether the handle for the Event Viewer is open.
if (NULL != m_hEventLog)
{
// Close the handle to the Event Viewer.
DeregisterEventSource( m_hEventLog );
m_hEventLog = NULL;
}
}
private:
// Create a handle for the event viewer.
HANDLE m_hEventLog;
// Define a method that writes to the Event Viewer.
BOOL WriteEventViewerLog(LPCSTR szNotification)
{
// Test whether the handle for the Event Viewer is open.
if (NULL != m_hEventLog)
{
// Write any strings to the Event Viewer and return.
return ReportEvent(
m_hEventLog,
EVENTLOG_INFORMATION_TYPE, 0, 0,
NULL, 1, 0, &szNotification, 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 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 and exit.
return pModuleInfo->SetGlobalNotifications(
pGlobalModule, GL_PRE_BEGIN_REQUEST );
}
モジュールで 関数をエクスポートする RegisterModule 必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、 スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したGlobal-Level HTTP モジュールの作成」を参照してください。
必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。
要件
| Type | 説明 |
|---|---|
| Client | - 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 |
| Header | Httpserv.h |