IHttpRequest：：GetHeader 方法

项目
03/16/2023

返回指定 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]指向接收返回标头值的长度的无符号长整数的指针。

返回值

指向包含指定标头的字符串的指针;如果未找到标头，则为 0。

注解

方法 GetHeader 返回当前请求的 HTTP 标头的值。方法有两个 GetHeader 重载版本。一个通过使用参数中包含的 pszHeaderName 字符串指定标头。另一个重载使用参数中包含的 ulHeaderIndex 无符号长整数。调用 GetHeader 方法后， pcchHeaderValue 参数将包含标头值的长度（以字符为单位），不包括终止字符。 pcchHeaderValue 如果未找到标头，则为 0。

参数指定的 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 版本的方法创建 HTTP 模块，该模块检索 User-Agent 请求的和 Accept-Language HTTP 标头。

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

        // Create buffers to store the returned header values.
        PCSTR pszUserAgent;
        PCSTR pszAcceptLanguage;

        // Create buffers to store lengths of the returned header values.
        USHORT cchUserAgent;
        USHORT cchAcceptLanguage;

        // Retrieve a pointer to the request.
        IHttpRequest * pHttpRequest = pHttpContext->GetRequest();

        // Test for an error.
        if (pHttpRequest != NULL)
        {
            // Clear the existing response.
            pHttpContext->GetResponse()->Clear();
            // Set the MIME type to plain text.
            pHttpContext->GetResponse()->SetHeader(
                HttpHeaderContentType,"text/plain",
                (USHORT)strlen("text/plain"),TRUE);

            // Look for the "User-Agent" header.
            pszUserAgent = pHttpRequest->GetHeader("User-Agent",&cchUserAgent);

            // The header length will be 0 if the header was not found.
            if (cchUserAgent == 0)
            {
                // Return a status message.
                WriteResponseMessage(pHttpContext,
                    "User-Agent: ","(none)");
            }
            else
            {
                // Allocate space to store the header.
                pszUserAgent = (PCSTR) pHttpContext->AllocateRequestMemory( cchUserAgent + 1 );
                
                // Test for an error.
                if (pszUserAgent==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 "User-Agent" header.
                pszUserAgent = pHttpRequest->GetHeader("User-Agent",&cchUserAgent);
                // Test for an error.
                if (pszUserAgent!=NULL)
                {
                    // Return the header information.
                    WriteResponseMessage(pHttpContext,
                        "User-Agent: ",pszUserAgent);
                }
            }

            // Look for the "Accept-Language" header.
            pszAcceptLanguage = pHttpRequest->GetHeader(HttpHeaderAcceptLanguage,&cchAcceptLanguage);

            // The header length will be 0 if the header was not found.
            if (cchAcceptLanguage == 0)
            {
                // Return a status message.
                WriteResponseMessage(pHttpContext,
                    "\nAccept-Language: ","(none)");
            }
            else
            {
                // Allocate space to store the header.
                pszAcceptLanguage = (PCSTR) pHttpContext->AllocateRequestMemory( cchAcceptLanguage + 1 );
                
                // Test for an error.
                if (pszAcceptLanguage==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 "Accept-Language" header.
                pszAcceptLanguage = pHttpRequest->GetHeader(HttpHeaderAcceptLanguage,&cchAcceptLanguage);                
                
                // Test for an error.
                if (pszAcceptLanguage!=NULL)
                {
                    // Return the header information.
                    WriteResponseMessage(pHttpContext,
                        "\nAccept-Language: ",pszAcceptLanguage);
                }
            }
            // 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

另请参阅

IHttpRequest 接口
 IHttpRequest：:D eleteHeader 方法
 IHttpRequest：：SetHeader 方法

通过

IHttpRequest：：GetHeader 方法

语法

参数

返回值

注解

示例

要求

另请参阅

反馈

其他资源