IHttpServer::D oCacheOperation-Methode

Artikel
07/19/2023

Führt einen bestimmten Cachevorgang aus.

Syntax

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

Parameter

cacheOperation
[IN] Ein CACHE_OPERATION Enumerationswert.

pCacheKey
[IN] Ein Zeiger auf eine IHttpCacheKey-Schnittstelle .

ppCacheSpecificData
[OUT] Ein Zeiger auf die Adresse einer IHttpCacheSpecificData-Schnittstelle .

pHttpTraceContext
[IN] Ein Zeiger auf eine IHttpTraceContext-Schnittstelle . (Optional.)

Rückgabewert

HRESULT. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Wert	BESCHREIBUNG
S_OK	Gibt an, dass der Vorgang erfolgreich war.

Bemerkungen

Die DoCacheOperation -Methode wird in HTTP-Modulen verwendet, um den Cachevorgang auszuführen, der cacheOperation vom -Parameter angegeben wird. Beispielsweise speichern bzw. entfernen die CACHE_OPERATION_ADD - und CACHE_OPERATION_DELETE-Enumerationswerte Objekte aus dem Cache. Wenn Ihr Modul die DoCacheOperation -Methode aufruft, muss es eine IHttpCacheKey Schnittstelle im pCacheKey Parameter übergeben, und IIS gibt eine IHttpCacheSpecificData Schnittstelle im ppCacheSpecificData Parameter zurück. Optional können Sie eine IHttpTraceContext Schnittstelle im pHttpTraceContext Parameter angeben, um die Anforderung zu identifizieren, die den Aufruf ausgelöst hat. (Dies ist nur zu Ablaufverfolgungszwecken erforderlich.)

Hinweis

Implementierer sollten DoCacheOperation nicht innerhalb der IHttpApplicationResolveModulesProvider::RegisterModule-Methode aufrufen, da es in der Anforderungspipeline zu früh ist.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie die DoCacheOperation -Methode verwendet wird, um ein HTTP-Modul zu erstellen, das auf einen CACHE_OPERATION_RETRIEVE-Vorgang testet und einen CACHE_OPERATION_ENUM-Vorgang auslöst.

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

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufkonvention verwenden, anstatt die Aufrufkonvention für jede Funktion explizit zu deklarieren.

Anforderungen

type	BESCHREIBUNG
Client	– IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 unter Windows 10
Server	– IIS 7.0 unter Windows Server 2008 – IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 unter Windows Server 2016
Produkt	– 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

Weitere Informationen

IHttpServer-Schnittstelle
CACHE_OPERATION-Enumeration
IHttpCacheKey-Schnittstelle
IHttpCacheSpecificData-Schnittstelle
IHttpTraceContext-Schnittstelle

Freigeben über