IXMLHTTPRequest2

HTTP リクエストの構成と送信、および HTTP レスポンス処理中の通知をコールバックで受け取るために必要なメソッドとプロパティを提供します。メモ このインターフェイスは Windows Phone 8.1 でサポートされています。 .

IXMLHTTPRequest2 インターフェイスは IXMLHTTPRequest3 インターフェイスによって拡張されています。IXMLHTTPRequest3 は IXMLHTTPRequest2 インターフェイスのすべてのメソッドとプロパティを継承します。

IXMLHTTPRequest2 インターフェイスは HTTP リクエスト操作を構成して送信し、レスポンス処理中の通知をコールバックで受け取ります。IXMLHTTPRequest2 により、アプリケーションはマルチスレッド アパートメント (MTA) で動作できます。これは Windows ランタイム (WinRT) で動作するための要件です。

IXMLHTTPRequest2 インターフェイスは次の機能をサポートします。

• 送信する HTTP リクエストにプロパティを設定する。
• 送信する HTTP リクエストで使用する Cookie を HTTP の Cookie ジャーに設定する。
• HTTP の Cookie ジャーから Cookie を取得する。
• HTTP レスポンスのダウンロードが完了する前に、受信中の HTTP レスポンス データを処理する。
• HTTP レスポンスを受け取るためのカスタム ストリームを作成する。

IXMLHTTPRequest2 はイベント処理にコールバック モデルを実装しています。IXMLHTTPRequest2 のメソッドは非同期呼び出しのみを許可するため、完了コールバックを受け取るには、アプリケーションが HTTP リクエストを作成するために IXMLHTTPRequest2::Open メソッドを呼び出す際に、IXMLHTTPRequest2Callback オブジェクトへのポインターを渡す必要があります。

IXMLHTTPRequest2 のリクエストを初期化し、そのリクエストのメソッド、URL、認証情報を指定します。このメソッドを呼び出した後、リクエストとデータ (存在する場合) をサーバーに送信するには Send メソッドを呼び出す必要があります。

成功すると S_OK を返します。

このメソッドはパラメーターで資格情報を渡せますが、これらの資格情報が最初のリクエストで自動的にサーバーへ送信されるわけではありません。pwszUserName および pwszPassword パラメーターは、サーバーが 401 - Unauthorized レスポンスでクライアントに資格情報を要求しない限り、サーバーへ送信されません。

例

//
// Create and initialize an IXMLHTTPRequest2 object
//
hr = CoCreateInstance(CLSID_FreeThreadedXMLHTTP60,
                      NULL,
                      CLSCTX_INPROC_SERVER,
                      IID_PPV_ARGS(&spXHR));

//
//Create and initialize an IXMLHTTPRequest2Callback object
//
hr = MakeAndInitialize<CXMLHttpRequest2Callback>(&spXhrCallback);

hr = spXHR->Open(L"GET",              // Method.
                 pcwszUrl,            // Url.
                 spXhrCallback.Get(), // Callback.
                 NULL,                // Username.
                 NULL,                // Password.
                 NULL,                // Proxy username.
                 NULL);               // Proxy password.

//
//Send the GET request
//
hr = spXHR->Send(NULL, 0);

hr = spXhrCallback->WaitForComplete(&dwStatus);

完全な例については、XML HTTP Request 2 GET サンプル および XML HTTP Request 2 POST サンプル を参照してください。

HTTP リクエストをサーバーへ非同期に送信します。成功すると、アプリが実装した IXMLHTTPRequest2Callback インターフェイスのメソッドが呼び出され、レスポンスが処理されます。

成功すると S_OK を返します。

Send を正常に呼び出すには、事前に Open メソッドを呼び出しておく必要があります。

このメソッドは非同期であるため、リクエストの処理が開始される前に直ちに戻ります。リクエストの処理が進むにつれて、アプリケーションには IXMLHTTPRequest2Callback インターフェイスを通じて通知されます。

POST リクエストで ISequentialStream を使用する代わりに、デスクトップ アプリでは SHCreateMemStream/SHCreateStreamOnFile を、Windows ストア アプリでは CreateStreamOverRandomAccessStream を使用できます。

現在の HTTP リクエストをキャンセルします。

成功すると S_OK を返します。

リクエストが中止された後、そのリクエストを表すオブジェクトは無効になります。

このメソッドはリクエストのキャンセルを保証するものではありません。アプリは、リクエストが正常に中止されたことを示す OnError コールバック メソッド、または中止処理が行われる前にリクエストが完了したことを示す OnResponseReceived コールバック メソッドを受け取るまで待機する必要があります。

指定した URL に関連付けられた Cookie を HTTP の Cookie ジャーに設定します。

成功すると S_OK を返します。

SetCookie メソッドの動作は、Windows ストア アプリと Windows デスクトップ アプリケーションで異なります。

Windows ストア アプリで使用した場合、SetCookie メソッドは既定でその Windows ストア アプリ内の永続的な Cookie として設定します。XHR_COOKIE の dwFlags メンバーに XHR_COOKIE_IS_SESSION フラグが設定されている場合、Cookie はアプリの現在のセッションに対してのみ設定されます。

Windows デスクトップ アプリケーションで使用した場合、SetCookie メソッドは既定で、システム全体に適用され、すべての Windows デスクトップ アプリケーションで共有される永続的な Cookie を設定します。XHR_COOKIE の dwFlags メンバーに XHR_COOKIE_IS_SESSION フラグが設定されている場合、Cookie はその Windows デスクトップ アプリケーションの現在のセッションに対してのみ設定されます。

HTTP レスポンスを受け取るための標準ストリームに代わるカスタム ストリームを提供します。

成功すると S_OK を返します。

このメソッドを呼び出すと、IXMLHTTPRequest2 はサーバーからレスポンス データを受信したときに ISequentialStream::Write メソッドを呼び出します。その時点でデータの処理を開始できますが、この呼び出しはサーバーからの後続データ受信と同一の流れで行われるため、負荷の高い処理は避けてください。IXMLHTTPRequest2 はカスタム ストリームに対して ISequentialStream::Read を呼び出さないため、アプリケーションが ISequentialStream::Read を使用する必要がない場合は E_NOTIMPL を返しても問題ありません。

送信する HTTP リクエストにプロパティを設定します。

成功すると S_OK を返します。

IXMLHTTPRequest2 インターフェイスの SetProperty メソッドは、IXMLHTTPRequest3 インターフェイスで新しいシナリオをサポートする次のプロパティによって拡張されています。

• XHR_PROP_NO_CACHE – HTTP リクエストに対するキャッシュの読み取りと書き込みを抑制します。
• XHR_PROP_EXTENDED_ERROR – 失敗時に、HTTP スタックが基になる Win32 エラー コードを含む HRESULT を OnError メソッドに提供するようにします。
• XHR_PROP_QUERY_STRING_UTF8 – HTTP リクエストのクエリ文字列を ACP ではなく UTF-8 でエンコードするようにします。
• XHR_PROP_IGNORE_CERT_ERRORS – 特定のサーバー証明書エラーを抑制します。

既定のリクエスト ヘッダーと共にサーバーへ送信する HTTP ヘッダーの名前を指定します。

成功すると S_OK を返します。

すべての HTTP レスポンス ヘッダーの値を取得します。

成功すると S_OK を返します。

各ヘッダーの名前と値のペアは、復帰と改行の組み合わせで区切られます。

返されるレスポンス ヘッダー情報は、OnHeadersAvailable コールバック メソッドが呼び出された後にのみ有効です。

例

HRESULT hr = S_OK;
WCHAR *pwszHeaderValue = NULL;
IXMLHTTPRequest2 *pIXMLHTTPRequest2 = NULL;

// Create IXMLHTTPRequest2 object and initialize pIXMLHTTPRequest2.
hr = pIXMLHTTPRequest2->GetAllResponseHeaders(&pwszHeaderValue);
if(SUCCEEDED(hr))
{
  MessageBox(NULL, pwszHeaderValue, L"All Response Headers", MB_OK);
}

if (pwszHeaderValue != NULL)
{
      CoTaskMemFree(pwszHeaderValue);
      pwszHeaderValue = NULL;
}

// Release pIXMLHTTPRequest2 when finished with it.

指定した URL に関連付けられた Cookie を HTTP の Cookie ジャーから取得します。

成功すると S_OK を返します。E_FAIL はエラーを示します。

レスポンス ヘッダーから HTTP ヘッダーの値を取得します。

成功すると S_OK を返します。

このメソッドの結果は、OnHeadersAvailable コールバック メソッドが呼び出された後にのみ有効です。

例

HRESULT hr = S_OK;
WCHAR *pwszHeaderValue = NULL;
IXMLHTTPRequest2 *pIXMLHTTPRequest2 = NULL;

// Create XMLHTTPRequest2 object and initialize pIXMLHTTP2Request.
hr = pIXMLHTTPRequest2->GetResponseHeader(L"Server", &pwszHeaderValue);
if(SUCCEEDED(hr))
{
   MessageBox(NULL, pwszHeaderValue, L"Response Header-Server", MB_OK);   
}   

if (pwszHeaderValue != NULL)
{
   CoTaskMemFree(pwszHeaderValue);
   pwszHeaderValue = NULL;
}

// Release pIXMLHTTPRequest2 when finished with it.