IWinHttpRequest::WaitForResponse メソッド
WaitForResponse メソッドは、非同期の Send メソッドが完了するまで待機します(省略可能なタイムアウト値は秒単位)。
構文
HRESULT WaitForResponse(
[in, optional] VARIANT Timeout,
[out, retval] VARIANT_BOOL *Succeeded
);
パラメーター
-
タイムアウト [in, 省略可能]
-
タイムアウト値 (秒単位)。 既定のタイムアウトは無限です。 タイムアウトを無限に明示的に設定するには、値 -1 を使用します。
-
成功 [out, retval]
-
次のいずれかの値を受け取ります。
値 説明 - VARIANT_TRUE
応答が受信されました。 - VARIANT_FALSE
指定されたタイムアウト期間を超えました。
戻り値
戻り値は成功した場合は S_OK 、それ以外の場合はエラー値です。
解説
このメソッドは、非同期要求への応答を待機している間に実行を中断します。 このメソッドは、Send の後に呼び出 す必要があります。 アプリケーションを呼び出すと、オプションの タイムアウト 値を秒単位で指定できます。 このメソッドがタイムアウトした場合、要求は中止されません。 これにより、呼び出し元のアプリケーションは、必要に応じて、このメソッドの後続の呼び出しで要求を待機し続けることができます。
同期 Send メソッドが直ちにを返した後、このプロパティを呼び出しても効果はありません。
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 varTrue;
VARIANT varEmpty;
CLSID clsid;
VariantInit(&varTrue);
V_VT(&varTrue) = VT_BOOL;
V_BOOL(&varTrue) = VARIANT_TRUE;
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, varTrue);
SysFreeString(bstrMethod);
SysFreeString(bstrUrl);
}
if (SUCCEEDED(hr))
{ // Send Request.
hr = pIWinHttpRequest->Send(varEmpty);
}
if (SUCCEEDED(hr))
{ // Wait for response.
VARIANT_BOOL varResult;
hr = pIWinHttpRequest->WaitForResponse(varEmpty, &varResult);
}
if (SUCCEEDED(hr))
{ // Get Response text.
hr = pIWinHttpRequest->get_ResponseText(&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", true);
// Send the HTTP request.
WinHttpReq.Send();
// Wait for the response.
WinHttpReq.WaitForResponse();
// Display the response text.
WScript.Echo( WinHttpReq.ResponseText);
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows XP、Windows 2000 Professional sp3 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server 2003、Windows 2000 Server SP3 [デスクトップ アプリのみ] |
| 再頒布可能パッケージ |
Windows XP および Windows 2000 で WinHTTP 5.0 およびインターネット エクスプローラー 5.01 以降。 |
| IDL |
|
| ライブラリ |
|
| [DLL] |
|