Метод IWinHttpRequest::SetRequestHeader

Статья
06/13/2023

Метод SetRequestHeader добавляет, изменяет или удаляет заголовок HTTP-запроса.

Синтаксис

HRESULT SetRequestHeader(
  [in] BSTR Header,
  [in] BSTR Value
);

Параметры

Заголовок [in]: Указывает имя задаемого заголовка, например "depth". Этот параметр не должен содержать двоеточие и должен быть фактическим текстом заголовка HTTP.
Значение [in]: Задает значение заголовка, например бесконечность.

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

Возвращаемое значение S_OK при успешном выполнении или значение ошибки в противном случае.

Заголовки передаются между перенаправлениями. Это может создать уязвимость системы безопасности. Чтобы избежать передачи заголовков при перенаправлении, используйте обратный вызов WINHTTP_STATUS_CALLBACK для исправления определенных заголовков при перенаправлении.

Метод SetRequestHeader позволяет вызывающей приложению добавлять или удалять заголовок HTTP-запроса перед отправкой запроса. Имя заголовка задается в поле Заголовок, а токен или значение заголовка — в поле Значение. Чтобы добавить заголовок, укажите имя и значение заголовка. Если уже существует другой заголовок с таким именем, он заменяется. Чтобы удалить заголовок, задайте для параметра Заголовок имя заголовка для удаления и задайте значение NULL.

Имя и значение заголовков запросов, добавленных с помощью этого метода, проверяются. Заголовки должны быть правильно сформированы. Дополнительные сведения о допустимых заголовках HTTP см. в статье RFC 2616. Если используется недопустимый заголовок, возникает ошибка и заголовок не добавляется.

Примечание

Для Windows XP и Windows 2000 см. раздел Требования к времени выполнения начальной страницы WinHTTP.

Примеры

В следующем примере показано, как открыть HTTP-подключение, задать заголовок запроса, отправить HTTP-запрос и прочитать текст ответа. Этот пример должен выполняться из командной строки.

#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // Variable for return value
    HRESULT    hr;

    // Initialize COM.
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid, NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }
    if (SUCCEEDED(hr))
    {    // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod, bstrUrl, varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {    // Set request header.
        BSTR bstrName  = SysAllocString(L"Date");
        BSTR bstrValue = SysAllocString(L"Fri, 16 Mar 2001 00:25:54 GMT");
        hr = pIWinHttpRequest->SetRequestHeader(bstrName, bstrValue);
        SysFreeString(bstrName);
        SysFreeString(bstrValue);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {    // Get Response headers.
        hr = pIWinHttpRequest->GetAllResponseHeaders(&bstrResponse);
    }
    if (SUCCEEDED(hr))
    {    // Print the response to a console.
        wprintf(L"%.256s",bstrResponse);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}

В следующем примере скрипта показано, как открыть HTTP-подключение, задать заголовок запроса и отправить HTTP-запрос.

// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Add/replace a request header.
WinHttpReq.SetRequestHeader("Date", Date());

// Send the HTTP request.
WinHttpReq.Send();

Требования

Требование	Значение
Минимальная версия клиента	Windows XP, Windows 2000 Профессиональная с пакетом обновления 3 (SP3) [только классические приложения]
Минимальная версия сервера	Windows Server 2003, Windows 2000 Server с пакетом обновления 3 (SP3) [только классические приложения]
Распространяемые компоненты	WinHTTP 5.0 и Internet Обозреватель 5.01 или более поздней версии в Windows XP и Windows 2000.
IDL	HttpRequest.idl
Библиотека	Winhttp.lib
DLL	Winhttp.dll

См. также раздел

IWinHttpRequest
WinHttpRequest
Версии WinHTTP

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