次の方法で共有

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 に指定されます。 ヘッダーを追加するには、ヘッダー名と値を指定します。 この名前の別のヘッダーが既に存在する場合は、置き換えられます。 ヘッダーを削除するには、 ヘッダー を削除するヘッダーの名前に設定し、 Value を NULL に設定 します。

このメソッドで追加された要求ヘッダーの名前と値が検証されます。 ヘッダーは整形式である必要があります。 有効な HTTP ヘッダーの詳細については、「 RFC 2616」を参照してください。 無効なヘッダーが使用されている場合は、エラーが発生し、ヘッダーは追加されません。

Note

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 およびインターネット エクスプローラー 5.01 以降。
IDL
HttpRequest.idl
ライブラリ
Winhttp.lib
[DLL]
Winhttp.dll

関連項目

IWinHttpRequest

WinHttpRequest

WinHTTP バージョン