IWinHttpRequest::SetRequestHeader 方法

SetRequestHeader方法會新增、變更或刪除 HTTP 要求標頭。

語法

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

參數

標頭 [in]

指定要設定的標頭名稱,例如「depth」。 此參數不應包含冒號,而且必須是 HTTP 標頭的實際文字。

[in]

指定標頭的值,例如 「infinity」。

傳回值

傳回值會在成功或錯誤值時 S_OK ,否則傳回值。

備註

標頭會跨重新導向傳輸。 這可建立安全性弱點。 若要避免在重新導向發生時傳送標頭,請使用 WINHTTP_STATUS_CALLBACK 回呼來更正重新導向時的特定標頭。

SetRequestHeader方法可讓呼叫的應用程式在傳送要求之前新增或刪除 HTTP 要求標頭。 標頭名稱是在 Header中指定,標頭權杖或值是在 Value中指定。 若要新增標頭,請提供標頭名稱和值。 如果已有另一個標頭與此名稱一起存在,則會加以取代。 若要刪除標頭,請將 Header 設定為要刪除的標頭名稱,並將 Value 設定為 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 Professional SP3 [僅限傳統型應用程式]
最低支援的伺服器
Windows Server 2003,Windows 2000 Server 與 SP3 [僅限桌面應用程式]
可轉散發套件
Windows XP 和 Windows 2000 上的 WinHTTP 5.0 和 Internet Explorer 5.01 或更新版本。
IDL
HttpRequest.idl
程式庫
WinHTTP.lib
DLL
Winhttp.dll

另請參閱

IWinHttpRequest

WinHttpRequest

WinHTTP 版本