WinHttpSetTimeouts
関数シグネチャ
// WINHTTP.dll
#include <windows.h>
BOOL WinHttpSetTimeouts(
void* hInternet,
INT nResolveTimeout,
INT nConnectTimeout,
INT nSendTimeout,
INT nReceiveTimeout
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hInternet | void* | inout | WinHttpOpen または WinHttpOpenRequest から返された HINTERNET ハンドル。 |
| nResolveTimeout | INT | in | 名前解決に使用するタイムアウト値をミリ秒単位で指定する integer 型の値。解決にこのタイムアウト値を超える時間がかかると、リクエストはキャンセルされます。初期値は 0 で、タイムアウトなし(無限)を意味します。 Windows Vista および Windows XP: NAME_RESOLUTION_TIMEOUT を使用して DNS タイムアウトを指定した場合、リクエストごとに 1 スレッドのオーバーヘッドが生じます。 |
| nConnectTimeout | INT | in | サーバー接続リクエストに使用するタイムアウト値をミリ秒単位で指定する integer 型の値。接続リクエストにこのタイムアウト値を超える時間がかかると、リクエストはキャンセルされます。初期値は 60,000(60 秒)です。 TCP/IP は、このパラメーターの値にかかわらず、3 ウェイの SYN/ACK 交換中にソケットをセットアップする際にタイムアウトする可能性があります。 |
| nSendTimeout | INT | in | リクエストの送信に使用するタイムアウト値をミリ秒単位で指定する integer 型の値。リクエストの送信にこのタイムアウト値を超える時間がかかると、送信はキャンセルされます。初期値は 30,000(30 秒)です。 |
| nReceiveTimeout | INT | in | リクエストに対するレスポンスを受信するためのタイムアウト値をミリ秒単位で指定する integer 型の値。レスポンスにこのタイムアウト値を超える時間がかかると、リクエストはキャンセルされます。初期値は 30,000(30 秒)です。 |
戻り値の型: BOOL
公式ドキュメント
HTTP トランザクションに関連するタイムアウトを設定します。
戻り値
成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。返されるエラーコードには次のものがあります。
| エラーコード | 説明 |
|---|---|
| 指定されたハンドルが正しい状態にないため、要求された操作を実行できません。 | |
| 指定されたハンドルの種類がこの操作に対して正しくありません。 | |
| 内部エラーが発生しました。 | |
| 要求された操作を完了するのに十分なメモリがありませんでした。(Windows エラーコード) | |
| タイムアウトパラメーターのうち 1 つ以上が、-1 以外の負の値になっています。 |
解説(Remarks)
WinHTTP が非同期モードで使用されている場合(つまり WinHttpOpen で WINHTTP_FLAG_ASYNC が設定されている場合)でも、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、GetLastError を呼び出します。
0 または -1 を指定すると、タイムアウトは無限に待機するよう設定されます。0 より大きい値を指定すると、タイムアウト値がミリ秒単位で設定されます。たとえば、30,000 はタイムアウトを 30 秒に設定します。-1 以外のすべての負の値は、関数を ERROR_INVALID_PARAMETER で失敗させます。
例
この例では、WinHttpSetTimeouts を使用して新しいタイムアウト値を設定する方法を示します。
// Use WinHttpOpen to obtain an HINTERNET handle.
HINTERNET hSession = WinHttpOpen(L"A WinHTTP Example Program/1.0",
WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
WINHTTP_NO_PROXY_NAME,
WINHTTP_NO_PROXY_BYPASS, 0);
if (hSession)
{
// Use WinHttpSetTimeouts to set a new time-out values.
if (!WinHttpSetTimeouts( hSession, 10000, 10000, 10000, 10000))
printf( "Error %u in WinHttpSetTimeouts.\n", GetLastError());
// PLACE ADDITIONAL CODE HERE.
// When finished, release the HINTERNET handle.
WinHttpCloseHandle(hSession);
}
else
{
printf("Error %u in WinHttpOpen.\n", GetLastError());
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WINHTTP.dll
#include <windows.h>
BOOL WinHttpSetTimeouts(
void* hInternet,
INT nResolveTimeout,
INT nConnectTimeout,
INT nSendTimeout,
INT nReceiveTimeout
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpSetTimeouts(
IntPtr hInternet, // void* in/out
int nResolveTimeout, // INT
int nConnectTimeout, // INT
int nSendTimeout, // INT
int nReceiveTimeout // INT
);<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpSetTimeouts(
hInternet As IntPtr, ' void* in/out
nResolveTimeout As Integer, ' INT
nConnectTimeout As Integer, ' INT
nSendTimeout As Integer, ' INT
nReceiveTimeout As Integer ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hInternet : void* in/out
' nResolveTimeout : INT
' nConnectTimeout : INT
' nSendTimeout : INT
' nReceiveTimeout : INT
Declare PtrSafe Function WinHttpSetTimeouts Lib "winhttp" ( _
ByVal hInternet As LongPtr, _
ByVal nResolveTimeout As Long, _
ByVal nConnectTimeout As Long, _
ByVal nSendTimeout As Long, _
ByVal nReceiveTimeout As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WinHttpSetTimeouts = ctypes.windll.winhttp.WinHttpSetTimeouts
WinHttpSetTimeouts.restype = wintypes.BOOL
WinHttpSetTimeouts.argtypes = [
ctypes.POINTER(None), # hInternet : void* in/out
ctypes.c_int, # nResolveTimeout : INT
ctypes.c_int, # nConnectTimeout : INT
ctypes.c_int, # nSendTimeout : INT
ctypes.c_int, # nReceiveTimeout : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpSetTimeouts = Fiddle::Function.new(
lib['WinHttpSetTimeouts'],
[
Fiddle::TYPE_VOIDP, # hInternet : void* in/out
Fiddle::TYPE_INT, # nResolveTimeout : INT
Fiddle::TYPE_INT, # nConnectTimeout : INT
Fiddle::TYPE_INT, # nSendTimeout : INT
Fiddle::TYPE_INT, # nReceiveTimeout : INT
],
Fiddle::TYPE_INT)#[link(name = "winhttp")]
extern "system" {
fn WinHttpSetTimeouts(
hInternet: *mut (), // void* in/out
nResolveTimeout: i32, // INT
nConnectTimeout: i32, // INT
nSendTimeout: i32, // INT
nReceiveTimeout: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpSetTimeouts(IntPtr hInternet, int nResolveTimeout, int nConnectTimeout, int nSendTimeout, int nReceiveTimeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpSetTimeouts' -Namespace Win32 -PassThru
# $api::WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)#uselib "WINHTTP.dll"
#func global WinHttpSetTimeouts "WinHttpSetTimeouts" sptr, sptr, sptr, sptr, sptr
; WinHttpSetTimeouts hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout ; 戻り値は stat
; hInternet : void* in/out -> "sptr"
; nResolveTimeout : INT -> "sptr"
; nConnectTimeout : INT -> "sptr"
; nSendTimeout : INT -> "sptr"
; nReceiveTimeout : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WINHTTP.dll"
#cfunc global WinHttpSetTimeouts "WinHttpSetTimeouts" sptr, int, int, int, int
; res = WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
; hInternet : void* in/out -> "sptr"
; nResolveTimeout : INT -> "int"
; nConnectTimeout : INT -> "int"
; nSendTimeout : INT -> "int"
; nReceiveTimeout : INT -> "int"; BOOL WinHttpSetTimeouts(void* hInternet, INT nResolveTimeout, INT nConnectTimeout, INT nSendTimeout, INT nReceiveTimeout)
#uselib "WINHTTP.dll"
#cfunc global WinHttpSetTimeouts "WinHttpSetTimeouts" intptr, int, int, int, int
; res = WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
; hInternet : void* in/out -> "intptr"
; nResolveTimeout : INT -> "int"
; nConnectTimeout : INT -> "int"
; nSendTimeout : INT -> "int"
; nReceiveTimeout : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
procWinHttpSetTimeouts = winhttp.NewProc("WinHttpSetTimeouts")
)
// hInternet (void* in/out), nResolveTimeout (INT), nConnectTimeout (INT), nSendTimeout (INT), nReceiveTimeout (INT)
r1, _, err := procWinHttpSetTimeouts.Call(
uintptr(hInternet),
uintptr(nResolveTimeout),
uintptr(nConnectTimeout),
uintptr(nSendTimeout),
uintptr(nReceiveTimeout),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction WinHttpSetTimeouts(
hInternet: Pointer; // void* in/out
nResolveTimeout: Integer; // INT
nConnectTimeout: Integer; // INT
nSendTimeout: Integer; // INT
nReceiveTimeout: Integer // INT
): BOOL; stdcall;
external 'WINHTTP.dll' name 'WinHttpSetTimeouts';result := DllCall("WINHTTP\WinHttpSetTimeouts"
, "Ptr", hInternet ; void* in/out
, "Int", nResolveTimeout ; INT
, "Int", nConnectTimeout ; INT
, "Int", nSendTimeout ; INT
, "Int", nReceiveTimeout ; INT
, "Int") ; return: BOOL●WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout) = DLL("WINHTTP.dll", "bool WinHttpSetTimeouts(void*, int, int, int, int)")
# 呼び出し: WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
# hInternet : void* in/out -> "void*"
# nResolveTimeout : INT -> "int"
# nConnectTimeout : INT -> "int"
# nSendTimeout : INT -> "int"
# nReceiveTimeout : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "winhttp" fn WinHttpSetTimeouts(
hInternet: ?*anyopaque, // void* in/out
nResolveTimeout: i32, // INT
nConnectTimeout: i32, // INT
nSendTimeout: i32, // INT
nReceiveTimeout: i32 // INT
) callconv(std.os.windows.WINAPI) i32;proc WinHttpSetTimeouts(
hInternet: pointer, # void* in/out
nResolveTimeout: int32, # INT
nConnectTimeout: int32, # INT
nSendTimeout: int32, # INT
nReceiveTimeout: int32 # INT
): int32 {.importc: "WinHttpSetTimeouts", stdcall, dynlib: "WINHTTP.dll".}pragma(lib, "winhttp");
extern(Windows)
int WinHttpSetTimeouts(
void* hInternet, // void* in/out
int nResolveTimeout, // INT
int nConnectTimeout, // INT
int nSendTimeout, // INT
int nReceiveTimeout // INT
);ccall((:WinHttpSetTimeouts, "WINHTTP.dll"), stdcall, Int32,
(Ptr{Cvoid}, Int32, Int32, Int32, Int32),
hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
# hInternet : void* in/out -> Ptr{Cvoid}
# nResolveTimeout : INT -> Int32
# nConnectTimeout : INT -> Int32
# nSendTimeout : INT -> Int32
# nReceiveTimeout : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpSetTimeouts(
void* hInternet,
int32_t nResolveTimeout,
int32_t nConnectTimeout,
int32_t nSendTimeout,
int32_t nReceiveTimeout);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
-- hInternet : void* in/out
-- nResolveTimeout : INT
-- nConnectTimeout : INT
-- nSendTimeout : INT
-- nReceiveTimeout : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpSetTimeouts = lib.func('__stdcall', 'WinHttpSetTimeouts', 'int32_t', ['void *', 'int32_t', 'int32_t', 'int32_t', 'int32_t']);
// WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
// hInternet : void* in/out -> 'void *'
// nResolveTimeout : INT -> 'int32_t'
// nConnectTimeout : INT -> 'int32_t'
// nSendTimeout : INT -> 'int32_t'
// nReceiveTimeout : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINHTTP.dll", {
WinHttpSetTimeouts: { parameters: ["pointer", "i32", "i32", "i32", "i32"], result: "i32" },
});
// lib.symbols.WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout)
// hInternet : void* in/out -> "pointer"
// nResolveTimeout : INT -> "i32"
// nConnectTimeout : INT -> "i32"
// nSendTimeout : INT -> "i32"
// nReceiveTimeout : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpSetTimeouts(
void* hInternet,
int32_t nResolveTimeout,
int32_t nConnectTimeout,
int32_t nSendTimeout,
int32_t nReceiveTimeout);
C, "WINHTTP.dll");
// $ffi->WinHttpSetTimeouts(hInternet, nResolveTimeout, nConnectTimeout, nSendTimeout, nReceiveTimeout);
// hInternet : void* in/out
// nResolveTimeout : INT
// nConnectTimeout : INT
// nSendTimeout : INT
// nReceiveTimeout : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Winhttp extends StdCallLibrary {
Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
boolean WinHttpSetTimeouts(
Pointer hInternet, // void* in/out
int nResolveTimeout, // INT
int nConnectTimeout, // INT
int nSendTimeout, // INT
int nReceiveTimeout // INT
);
}@[Link("winhttp")]
lib LibWINHTTP
fun WinHttpSetTimeouts = WinHttpSetTimeouts(
hInternet : Void*, # void* in/out
nResolveTimeout : Int32, # INT
nConnectTimeout : Int32, # INT
nSendTimeout : Int32, # INT
nReceiveTimeout : Int32 # INT
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHttpSetTimeoutsNative = Int32 Function(Pointer<Void>, Int32, Int32, Int32, Int32);
typedef WinHttpSetTimeoutsDart = int Function(Pointer<Void>, int, int, int, int);
final WinHttpSetTimeouts = DynamicLibrary.open('WINHTTP.dll')
.lookupFunction<WinHttpSetTimeoutsNative, WinHttpSetTimeoutsDart>('WinHttpSetTimeouts');
// hInternet : void* in/out -> Pointer<Void>
// nResolveTimeout : INT -> Int32
// nConnectTimeout : INT -> Int32
// nSendTimeout : INT -> Int32
// nReceiveTimeout : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinHttpSetTimeouts(
hInternet: Pointer; // void* in/out
nResolveTimeout: Integer; // INT
nConnectTimeout: Integer; // INT
nSendTimeout: Integer; // INT
nReceiveTimeout: Integer // INT
): BOOL; stdcall;
external 'WINHTTP.dll' name 'WinHttpSetTimeouts';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHttpSetTimeouts"
c_WinHttpSetTimeouts :: Ptr () -> Int32 -> Int32 -> Int32 -> Int32 -> IO CInt
-- hInternet : void* in/out -> Ptr ()
-- nResolveTimeout : INT -> Int32
-- nConnectTimeout : INT -> Int32
-- nSendTimeout : INT -> Int32
-- nReceiveTimeout : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhttpsettimeouts =
foreign "WinHttpSetTimeouts"
((ptr void) @-> int32_t @-> int32_t @-> int32_t @-> int32_t @-> returning int32_t)
(* hInternet : void* in/out -> (ptr void) *)
(* nResolveTimeout : INT -> int32_t *)
(* nConnectTimeout : INT -> int32_t *)
(* nSendTimeout : INT -> int32_t *)
(* nReceiveTimeout : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)
(cffi:defcfun ("WinHttpSetTimeouts" win-http-set-timeouts :convention :stdcall) :int32
(h-internet :pointer) ; void* in/out
(n-resolve-timeout :int32) ; INT
(n-connect-timeout :int32) ; INT
(n-send-timeout :int32) ; INT
(n-receive-timeout :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHttpSetTimeouts = Win32::API::More->new('WINHTTP',
'BOOL WinHttpSetTimeouts(LPVOID hInternet, int nResolveTimeout, int nConnectTimeout, int nSendTimeout, int nReceiveTimeout)');
# my $ret = $WinHttpSetTimeouts->Call($hInternet, $nResolveTimeout, $nConnectTimeout, $nSendTimeout, $nReceiveTimeout);
# hInternet : void* in/out -> LPVOID
# nResolveTimeout : INT -> int
# nConnectTimeout : INT -> int
# nSendTimeout : INT -> int
# nReceiveTimeout : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WinHttpCloseHandle — WinHTTPハンドルを閉じてリソースを解放する。
- f WinHttpConnect — 指定サーバーへの接続を確立し接続ハンドルを返す。
- f WinHttpOpen — WinHTTPセッションを初期化しセッションハンドルを返す。
- f WinHttpOpenRequest — HTTP要求ハンドルを作成する。