IHttpResponse：：GetHeader 方法

2023-03-16

返回指定 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 标头的 ID。

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 ID。

注意

HTTP_HEADER_ID枚举在 Http.h 头文件中定义。

调用 GetHeader 方法后， pcchHeaderValue 参数将包含标头值的长度（以字符为单位，不包括终止字符），如果未找到标头，则为 0。

示例

下面的代码示例演示如何使用 GetHeader 方法创建检索和 Location 标头值的 Server HTTP 模块。然后，该模块会将此信息发送到 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) 而不是为每个函数显式声明调用约定。

要求

类型	说明
客户端	- 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 方法

通过

IHttpResponse：：GetHeader 方法

语法

参数

返回值

注解

示例

要求

另请参阅

反馈

其他资源