IWinHttpRequest::SetTimeouts メソッド
SetTimeouts メソッドは、送受信操作の個々のタイムアウト コンポーネントをミリ秒単位で指定します。
構文
HRESULT SetTimeouts(
[in] long ResolveTimeout,
[in] long ConnectTimeout,
[in] long SendTimeout,
[in] long ReceiveTimeout
);
パラメーター
-
ResolveTimeout [in]
-
ホスト名 (など
www.microsoft.com) を IP アドレス (192.168.131.199 など) に解決するときに適用されるタイムアウト値 (ミリ秒単位)。 既定値は 0 で、タイムアウト (無限) がないことを意味します。 NAME_RESOLUTION_TIMEOUTを使用して DNS タイムアウトを指定すると、要求ごとに 1 つのスレッドのオーバーヘッドが発生します。 -
ConnectTimeout [in]
-
ターゲット サーバーとの通信ソケットを確立するときに適用されるタイムアウト値 (ミリ秒単位)。 既定値は 60,000 (60 秒) です。
-
SendTimeout [in]
-
通信ソケット上の要求データの個々のパケットをターゲット サーバーに送信するときに適用されるタイムアウト値 (ミリ秒単位)。 通常、HTTP サーバーに送信される大きな要求は複数のパケットに分割されます。送信タイムアウトは、各パケットを個別に送信する場合に適用されます。 既定値は 30,000 (30 秒) です。
-
ReceiveTimeout [in]
-
ターゲット サーバーから応答データのパケットを受信するときに適用されるタイムアウト値 (ミリ秒単位)。 大きな応答は複数のパケットに分割されます。受信タイムアウトは、ソケットからデータの各パケットをフェッチするために適用されます。 既定値は 30,000 (30 秒) です。
戻り値
戻り値は成功した場合は S_OK 、それ以外の場合はエラー値です。
解説
すべてのパラメーターが必須です。 値が 0 または -1 の場合、タイムアウトが無限に待機するように設定されます。 0 より大きい値は、タイムアウト値をミリ秒単位で設定します。 たとえば、30,000 の場合、タイムアウトは 30 秒に設定されます。 -1 以外のすべての負の値を指定すると、このメソッドは失敗します。
タイムアウト値は Winsock レイヤーに適用されます。
Note
Windows XP および Windows 2000 の場合は、WinHttp スタート ページの 「ランタイム要件 」セクションを参照してください。
例
次の例は、すべての WinHTTP タイムアウトを 30 秒に設定し、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))
{ // Set Time-outs.
hr = pIWinHttpRequest->SetTimeouts(30000, 30000,
30000, 30000);
}
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))
{ // Send Request.
hr = pIWinHttpRequest->Send(varEmpty);
}
if (SUCCEEDED(hr))
{ // Get Response text.
hr = pIWinHttpRequest->GetAllResponseHeaders(&bstrResponse);
}
if (SUCCEEDED(hr))
{ // Print response to console.
wprintf(L"%.256s",bstrResponse);
}
// Release memory.
if (pIWinHttpRequest)
pIWinHttpRequest->Release();
if (bstrResponse)
SysFreeString(bstrResponse);
CoUninitialize();
return 0;
}
次のスクリプトの例では、すべての WinHTTP タイムアウトを 30 秒に設定し、HTTP 接続を開き、HTTP 要求を送信する方法を示します。
// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");
// Set time-outs. If time-outs are set, they must
// be set before open.
WinHttpReq.SetTimeouts(30000, 30000, 30000, 30000);
// Initialize an HTTP request.
WinHttpReq.Open("GET", "https://www.microsoft.com", false);
// 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 |
|
| ライブラリ |
|
| [DLL] |
|