IHttpSite：：GetSiteId 方法

擷取網站的唯一識別碼。

語法

virtual DWORD GetSiteId(  
   VOID  
) const = 0;  

參數

此方法不會採用任何參數。

傳回值

， DWORD 包含網站的唯一識別碼。

備註

方法 GetSiteId 可讓您擷取唯一的數值，以識別正在處理目前要求的網站。 Web 系統管理員在 IIS 網頁伺服器上建立的每個網站都會自動指派一個數位，以區分網站與相同伺服器上的其他網站。

注意

此唯一識別碼用於管理網站和記錄 Web 要求。 例如，在執行 IIS 之伺服器上的預設網站會指派數位 1，預設會將預設網站 Web 活動中的所有記錄檔儲存在 %SystemRoot%\System32\Logfiles\W3SVC1 資料夾中。 建立的其他網站將會指派唯一數值，以演算法方式從網站的設定產生。

範例

下列程式碼範例示範如何使用 GetSiteId 方法來建立擷取 IHttpSite 介面的 HTTP 模組。 模組會使用 GetSiteId 來擷取網站的唯一識別碼。 模組接著會將網站的識別碼傳回至 Web 用戶端並結束。

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

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

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

規格需求

類型	描述
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
標頭	Httpserv.h

另請參閱

IHttpCoNtext：：GetSite 方法
IHttpSite 介面
IHttpSite：：GetSiteName 方法