IHttpSite::GetSiteId-Methode

Artikel
07/19/2023

Ruft die eindeutige ID für die Website ab.

Syntax

virtual DWORD GetSiteId(  
   VOID  
) const = 0;

Parameter

Diese Methode nimmt zwei Parameter entgegen.

Rückgabewert

Ein DWORD , der die eindeutige ID für die Website enthält.

Bemerkungen

Mit GetSiteId der -Methode können Sie den eindeutigen numerischen Wert abrufen, der die Website identifiziert, die die aktuelle Anforderung verarbeitet. Jeder Website, die ein Webadministrator auf einem IIS-Webserver erstellt, wird automatisch eine Nummer zugewiesen, die die Website von anderen Websites auf demselben Server unterscheidet.

Hinweis

Dieser eindeutige Bezeichner wird zum Verwalten von Websites und zum Protokollieren von Webanforderungen verwendet. Beispielsweise wird der Standardwebsite auf einem Server, auf dem IIS ausgeführt wird, die Nummer 1 zugewiesen, und standardmäßig werden alle Protokolldateien der Webaktivität für die Standardwebsite im Ordner %SystemRoot%\System32\Logfiles\W3SVC1 gespeichert. Zusätzlichen Websites, die erstellt werden, wird ein eindeutiger numerischer Wert zugewiesen, der algorithmisch aus den Einstellungen der Website generiert wird.

Beispiel

Das folgende Codebeispiel veranschaulicht die Verwendung der GetSiteId -Methode zum Erstellen eines HTTP-Moduls, das eine IHttpSite-Schnittstelle abruft. Das Modul verwendet GetSiteId , um den eindeutigen Bezeichner für die Website abzurufen. Das Modul gibt dann den Bezeichner für die Website an einen Webclient zurück und beendet es.

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

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

        // Retrieve a pointer to an IHttpSite class.
        IHttpSite * pHttpSite = pHttpContext->GetSite();

        if (NULL != pHttpSite)
        {
            // Buffer for string value.
            char * pszSiteId = NULL;

            // Retrieve the site ID.
            DWORD dwSiteId = pHttpSite->GetSiteId();
            
            // Allocate storage space for the site ID.
            pszSiteId = (char*) pHttpContext->AllocateRequestMemory(64);

            if (NULL != pszSiteId)
            {
                // Convert the site ID to a string.
                ltoa(dwSiteId,pszSiteId,10);
                // Clear the existing buffer.
                pHttpContext->GetResponse()->Clear();
                // Return the site information.
                WriteResponseMessage(pHttpContext,
                    "Site ID: ",pszSiteId);
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
        }

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

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // 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 first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

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

// 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 MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

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

IHttpContext::GetSite-Methode
IHttpSite-Schnittstelle
IHttpSite::GetSiteName-Methode

Freigeben über