IHttpResponse：：GetHeader 方法

傳回指定之 HTTP 標頭的值。

語法

virtual PCSTR GetHeader(  
   IN PCSTR pszHeaderName,  
   OUT USHORT* pcchHeaderValue = NULL  
) const = 0;  
  
virtual PCSTR GetHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex,  
   OUT USHORT* pcchHeaderValue = NULL  
) const = 0;

參數

pszHeaderName
[IN]字串的指標，其中包含要傳回之標頭的名稱。

ulHeaderIndex
[IN]要傳回之 HTTP 標頭的識別碼。

pcchHeaderValue
[OUT]的 USHORT 指標，可接收標頭值的長度。

傳回值

包含指定標頭之字串的指標。

備註

方法 GetHeader 會傳回 HTTP 標頭的值。方法有兩個 GetHeader 多載版本。其中一個會使用包含在參數中的 pszHeaderName 字串來指定標頭。另一個多載會使用參數中包含的 ulHeaderIndex 不帶正負號長整數。

參數指定的 pszHeaderName 標頭名稱可以是自訂標頭或標頭，定義于要求批註 (RFC) 1945：「超文字傳輸通訊協定 -- HTTP/1.0」或 RFC 2616「超文字傳輸通訊協定 -- HTTP/1.1」。

注意

參數 pszHeaderName 無法設定為 Null。

參數 ulHeaderIndex 會指定列舉中列出的 HTTP 標頭識別碼 HTTP_HEADER_ID 。

注意

列舉 HTTP_HEADER_ID 定義于 Http.h 標頭檔中。

呼叫 GetHeader 方法之後， pcchHeaderValue 參數會包含字元中的標頭值長度，不包括終止字元，如果找不到標頭，則為 0。

範例

下列程式碼範例示範如何使用 GetHeader 方法來建立 HTTP 模組，以擷取和 Location 標頭的值 Server 。模組接著會將此資訊傳送至 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 );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Buffers to store the header values.
        PCSTR pszServerHeader;
        PCSTR pszLocationHeader;

        // Lengths of the returned header values.
        USHORT cchServerHeader;
        USHORT cchLocationHeader;

        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Clear the existing response.
            pHttpResponse->Clear();
            // Set the MIME type to plain text.
            pHttpResponse->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);
            
            // Retrieve the length of the "Server" header.
            pszServerHeader = pHttpResponse->GetHeader("Server",&cchServerHeader);
            
            if (cchServerHeader > 0)
            {
                // Allocate space to store the header.
                pszServerHeader = (PCSTR) pHttpContext->AllocateRequestMemory( cchServerHeader + 1 );
                
                // Test for an error.
                if (pszServerHeader==NULL)
                {
                    // Set the error status.
                    hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
                    pProvider->SetErrorStatus( hr );
                    // End additional processing.
                    return RQ_NOTIFICATION_FINISH_REQUEST;
                }
                
                // Retrieve the "Server" header.
                pszServerHeader = pHttpResponse->GetHeader(
                    "Server",&cchServerHeader);
                // Return the "Server" header to the client.
                WriteResponseMessage(pHttpContext,
                    "Server: ",pszServerHeader);
            }
            
            // Retrieve the length of the "Location" header.
            pszLocationHeader = pHttpResponse->GetHeader(
                HttpHeaderLocation,&cchLocationHeader);

            if (cchLocationHeader > 0)
            {
                // Allocate space to store the header.
                pszLocationHeader =
                    (PCSTR) pHttpContext->AllocateRequestMemory( cchLocationHeader + 1 );
                
                // Test for an error.
                if (pszServerHeader==NULL)
                {
                    // Set the error status.
                    hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
                    pProvider->SetErrorStatus( hr );
                    // End additional processing.
                    return RQ_NOTIFICATION_FINISH_REQUEST;
                }

                // Retrieve the "Location" header.
                pszLocationHeader = pHttpResponse->GetHeader(
                    HttpHeaderLocation,&cchLocationHeader);
                // Return the "Location" header to the client.
                WriteResponseMessage(pHttpContext,
                    "Location: ",pszLocationHeader);
            }
            // 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) 而不是明確宣告每個函式的呼叫慣例。

規格需求

類型	Description
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

另請參閱

IHttpResponse 介面
 IHttpResponse：：SetHeader 方法
 IHttpResponse：:D eleteHeader 方法

意見反應

此頁面對您有幫助嗎？

Last updated on 2023-03-16

共用方式為

IHttpResponse：：GetHeader 方法

語法

參數

傳回值

備註

範例

規格需求

另請參閱

意見反應

其他資源