Метод IHttpResponse::SetHeader

Статья
07/19/2023

Задает или добавляет значение указанного заголовка HTTP-ответа.

Синтаксис

virtual HRESULT SetHeader(  
   IN PCSTR pszHeaderName,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;  
  
virtual HRESULT SetHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;

Параметры

pszHeaderName
[IN] Указатель на строку, содержащую имя задается http-заголовка.

ulHeaderIndex
[IN] Идентификатор задается заголовка HTTP.

pszHeaderValue
[IN] Указатель на строку, содержащую задается значение заголовка.

cchHeaderValue
[IN] Длина (в символах) значения заголовка, не включая символ \0.

fReplace
[IN] Указывает, следует ли перезаписывать существующий заголовок.

Возвращаемое значение

Объект HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Значение	Описание:
S_OK	Указывает, что операция прошла успешно.
ERROR_INVALID_DATA	Указывает, что данные недопустимы (например, данные в заголовке слишком длинные).
ERROR_INVALID_PARAMETER	Указывает, что указанный параметр недопустим (например, параметр имеет значение NULL).
ERROR_NOT_ENOUGH_MEMORY	Указывает, что для выполнения операции недостаточно памяти.

Метод SetHeader задает значение заголовка HTTP для текущего ответа. Существует две перегруженные SetHeader версии метода . Первый позволяет указать заголовок с помощью строки, содержащейся в параметре pszHeaderName . Другая перегрузка использует длинное целое число без знака, содержащееся в параметре ulHeaderIndex .

Примечание

Не следует использовать перегрузку ulHeaderIndex , которая использует параметр для задания значения заголовка Server , так как ваше значение будет добавлено к существующему значению заголовка. Вместо этого используйте pszHeaderName параметр .

Имя заголовка, заданное pszHeaderName параметром , может быть пользовательским заголовком или заголовком, определенным в разделе Запрос комментариев (RFC) 1945, "Протокол передачи гипертекстов — HTTP/1.0" или RFC 2616, "Протокол передачи гипертекстов - HTTP/1.1".

Примечание

Параметр pszHeaderName не может иметь значение NULL.

Параметр ulHeaderIndex задает идентификатор http-заголовка, указанного в перечислении HTTP_HEADER_ID .

Примечание

Перечисление HTTP_HEADER_ID определяется в файле заголовка Http.h.

fReplace Если параметр имеет значение true, указанное значение заголовка заменит существующее значение заголовка, если заголовок существует. Если fReplace имеет значение false, указанное значение заголовка должно быть добавлено к существующему заголовку и отделяться от самого заголовка запятой.

Примечание

Другие модули или обработчики могут вызывать SetHeader метод для замены значения или добавления значений к указанному значению.

Пример

В следующем примере кода показано, как использовать обе перегрузки SetHeader метода , чтобы заменить http Content-Type и Server заголовки пользовательскими значениями и задать для заголовка HTTP Refresh определенное количество секунд.

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

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

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Set the "Refresh" header name.
        char szRefreshName[] = "Refresh";
        // Set the "Refresh" header value.
        char szRefreshValue[] = "30";
        // Set the "Content-Type" header value.
        char szContentType[] = "text/plain";
        // Set the "Server" header value.
        char szServerValue[] = "MyServer/7.0";

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

        // Test for an error.
        if (pHttpResponse != NULL)
        {

            // Set the "Refresh" header.
            hr = pHttpResponse->SetHeader(
                szRefreshName,szRefreshValue,
                (USHORT)strlen(szRefreshValue),FALSE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Set the "Content-Type" header.
            hr = pHttpResponse->SetHeader(
                HttpHeaderContentType,szContentType,
                (USHORT)strlen(szContentType),TRUE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Set the "Server" header.
            hr = pHttpResponse->SetHeader(
                "Server",szServerValue,
                (USHORT)strlen(szServerValue),TRUE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
        }
            
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

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

Модуль должен экспортировать функцию RegisterModule . Эту функцию можно экспортировать, создав файл определения модуля (DEF- файл) для проекта, или скомпилировать модуль с помощью /EXPORT:RegisterModule параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Request-Level с помощью машинного кода.

При необходимости можно скомпилировать код с помощью __stdcall (/Gz) соглашения о вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

Тип	Описание
клиент	— IIS 7.0 в Windows Vista — IIS 7.5 в Windows 7 — IIS 8.0 в Windows 8 — IIS 10.0 в Windows 10
Сервер	— IIS 7.0 в Windows Server 2008 — IIS 7.5 в Windows Server 2008 R2 — IIS 8.0 в Windows Server 2012 — IIS 8.5 в Windows Server 2012 R2 — IIS 10.0 в Windows Server 2016
Продукт	— 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::D eleteHeader
Метод IHttpResponse::GetHeader

Поделиться через

Метод IHttpResponse::SetHeader

Синтаксис

Параметры

Возвращаемое значение

Комментарии

Пример

Требования

См. также:

Обратная связь

Дополнительные ресурсы