IHttpServer::D oCacheOperation メソッド

特定のキャッシュ操作を実行します。

構文

virtual HRESULT DoCacheOperation(  
   IN CACHE_OPERATION cacheOperation,  
   IN IHttpCacheKey* pCacheKey,  
   OUT IHttpCacheSpecificData** ppCacheSpecificData,  
   IN IHttpTraceContext* pHttpTraceContext = NULL  
) = 0;  

パラメーター

cacheOperation
[IN] CACHE_OPERATION 列挙値。

pCacheKey
[IN] IHttpCacheKey インターフェイスへのポインター。

ppCacheSpecificData
[OUT] IHttpCacheSpecificData インターフェイスのアドレスへのポインター。

pHttpTraceContext
[IN] IHttpTraceContext インターフェイスへのポインター。 (省略可能)

戻り値

HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。

値	説明
S_OK	操作が成功したことを示します。

解説

メソッドは DoCacheOperation 、 パラメーターで指定されたキャッシュ操作を実行するために HTTP モジュールで cacheOperation 使用されます。 たとえば、 CACHE_OPERATION_ADD と CACHE_OPERATION_DELETE 列挙値は、それぞれオブジェクトをキャッシュに格納または削除します。 モジュールが メソッドをDoCacheOperation呼び出すときは、 パラメーターに インターフェイスをpCacheKeyIHttpCacheKey渡す必要があり、IIS は パラメーターで インターフェイスをIHttpCacheSpecificDatappCacheSpecificData返します。 必要に応じて、 パラメーターに インターフェイスを IHttpTraceContext 指定して、 pHttpTraceContext 呼び出しをトリガーした要求を識別できます。 (これはトレース目的でのみ必要です)。

注意

IHttpApplicationResolveModulesProvider::RegisterModule メソッド内で DoCacheOperation を呼び出さないでください。これは、要求パイプラインの早すぎるためです。

例

次のコード例では、 メソッドを DoCacheOperation 使用して、 CACHE_OPERATION_RETRIEVE 操作をテストし、CACHE_OPERATION_ENUM操作をトリガーする HTTP モジュールを作成 する方法を示します。

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

IHttpServer * g_pGlobalInfo;

// Create the module's global class.
class MyGlobalModule : public CGlobalModule
{
public:
    GLOBAL_NOTIFICATION_STATUS
    OnGlobalCacheOperation(
        IN ICacheProvider * pProvider
    )
    {
        if (CACHE_OPERATION_RETRIEVE == pProvider->GetCacheOperation())
        {
            // Retrieve an IHttpCacheKey interface.
            IHttpCacheKey * pCacheKey = pProvider->GetCacheKey();
            // Test for an error.
            if (NULL == pCacheKey) return GL_NOTIFICATION_CONTINUE;
            
            // Initialize an IHttpCacheSpecificData interface pointer.
            IHttpCacheSpecificData * pCacheSpecificData = NULL;
            
            // Peform a cache enumeration operation.
            HRESULT hr = g_pGlobalInfo->DoCacheOperation(
                CACHE_OPERATION_ENUM,pCacheKey,&pCacheSpecificData,NULL);
            
            // Test for an error.
            if (FAILED(hr)) return GL_NOTIFICATION_HANDLED;
        }

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

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

    g_pGlobalInfo = 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_CACHE_OPERATION );
}

モジュールは RegisterModule 関数をエクスポートする必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したRequest-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

参照

IHttpServer インターフェイス
CACHE_OPERATION 列挙
IHttpCacheKey インターフェイス
IHttpCacheSpecificData インターフェイス
IHttpTraceContext インターフェイス