WinHttpQueryDataAvailable
関数シグネチャ
// WINHTTP.dll
#include <windows.h>
BOOL WinHttpQueryDataAvailable(
void* hRequest,
DWORD* lpdwNumberOfBytesAvailable
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hRequest | void* | inout | WinHttpOpenRequest が返した有効な HINTERNET ハンドル。WinHttpQueryDataAvailable を呼び出す前に、このハンドルに対して WinHttpReceiveResponse を呼び出し、それが完了している必要があります。 |
| lpdwNumberOfBytesAvailable | DWORD* | inout | 利用可能なバイト数を受け取る unsigned long 整数変数へのポインター。WinHTTP を非同期モードで使用する場合は、このパラメーターを常に NULL に設定し、コールバック関数内でデータを取得してください。これを行わないとメモリフォールトが発生する可能性があります。 |
戻り値の型: BOOL
公式ドキュメント
WinHttpReadData で読み取り可能なデータ量をバイト単位で返します。
戻り値
関数が成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。返されるエラーコードには次のものがあります。
| エラーコード | 説明 |
|---|---|
| サーバーとの接続がリセットまたは終了されたか、互換性のない SSL プロトコルが検出されました。たとえば、WinHTTP バージョン 5.1 は、クライアントが明示的に有効にしない限り SSL2 をサポートしません。 | |
| 指定されたハンドルが正しい状態にないため、要求された操作を完了できません。 | |
| 指定されたハンドルの種類が、この操作に対して正しくありません。 | |
| 内部エラーが発生しました。 | |
| 操作がキャンセルされました。通常、操作が完了する前に、要求が動作していたハンドルが閉じられたことが原因です。 | |
| 要求がタイムアウトしました。 | |
| 要求された操作を完了するのに十分なメモリがありませんでした。(Windows エラーコード) |
解説(Remarks)
WinHTTP を非同期モードで使用している場合(つまり WinHttpOpen で WINHTTP_FLAG_ASYNC が設定されている場合)でも、この関数は同期的にも非同期的にも動作できます。FALSE を返した場合は失敗しており、 GetLastError を呼び出して拡張エラー情報を取得できます。TRUE を返した場合は、WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE 完了通知を使用して、この関数が成功したかどうかとパラメーターの値を判断します。WINHTTP_CALLBACK_STATUS_REQUEST_ERROR 完了通知は、操作が非同期的に完了したものの失敗したことを示します。
残りのデータ量は、 WinHttpQueryDataAvailable の呼び出しで示された利用可能なすべてのデータが読み取られるまで再計算されません。
レスポンスが完全に読み取られたかどうかを判断するには、WinHttpReadData の戻り値を使用してください。
WinHttpOpenRequest 関数で作成され WinHttpSendRequest で送信された HINTERNET ハンドルの場合、 WinHttpQueryDataAvailable を使用する前に、そのハンドルに対して WinHttpReceiveResponse を呼び出す必要があります。
WinHttpSetStatusCallback でステータスコールバック関数がインストールされている場合、WinHttpSetStatusCallback の dwNotificationFlags パラメーターで設定された次の通知のうち該当するものが、利用可能なデータの確認の進行状況を示します。
- WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE
- WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED
- WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE
例
次の例は、セキュアトランザクションのセマンティクスを使用して HTTPS サーバーからリソースをダウンロードする方法を示しています。このサンプルコードは、WinHTTP API を初期化し、対象の HTTPS サーバーを選択し、このセキュアなリソースに対する要求を開いて送信します。 WinHttpQueryDataAvailable を要求ハンドルとともに使用してダウンロード可能なデータ量を判断し、その後 WinHttpReadData を使用してそのデータを読み取ります。このプロセスは、ドキュメント全体が取得され表示されるまで繰り返されます。
一部のデータをできるだけ早く取得したい場合(つまり、受信しながらデータを処理および解析する場合)は、WinHttpQueryDataAvailable と WinHttpReadData を呼び出してください。レスポンス全体をできるだけ早くダウンロードしようとしている場合は、WinHttpReadData を直接呼び出してください。WinHttpReadData は完了する前にバッファーを満たそうとするためです。
また、以下のコード例ではループの反復ごとにメモリを割り当てています。パフォーマンスが重要な本番コードでは、代わりに適切なサイズのバッファー(おそらく 1 メガバイト)から開始し、必要に応じてサイズを変更するとよいでしょう。実際には、WinHttpQueryDataAvailable が返すのは最大でも 8 キロバイトです。
DWORD dwSize = 0;
DWORD dwDownloaded = 0;
LPSTR pszOutBuffer;
BOOL bResults = FALSE;
HINTERNET hSession = NULL,
hConnect = NULL,
hRequest = NULL;
// Use WinHttpOpen to obtain a session handle.
hSession = WinHttpOpen( L"WinHTTP Example/1.0",
WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
WINHTTP_NO_PROXY_NAME,
WINHTTP_NO_PROXY_BYPASS, 0);
// Specify an HTTP server.
if (hSession)
hConnect = WinHttpConnect( hSession, L"www.microsoft.com",
INTERNET_DEFAULT_HTTPS_PORT, 0);
// Create an HTTP request handle.
if (hConnect)
hRequest = WinHttpOpenRequest( hConnect, L"GET", NULL,
NULL, WINHTTP_NO_REFERER,
WINHTTP_DEFAULT_ACCEPT_TYPES,
WINHTTP_FLAG_SECURE);
// Send a request.
if (hRequest)
bResults = WinHttpSendRequest( hRequest,
WINHTTP_NO_ADDITIONAL_HEADERS,
0, WINHTTP_NO_REQUEST_DATA, 0,
0, 0);
// End the request.
if (bResults)
bResults = WinHttpReceiveResponse( hRequest, NULL);
// Continue to verify data until there is nothing left.
if (bResults)
do
{
// Verify available data.
dwSize = 0;
if (!WinHttpQueryDataAvailable( hRequest, &dwSize))
printf( "Error %u in WinHttpQueryDataAvailable.\n",
GetLastError());
// Allocate space for the buffer.
pszOutBuffer = new char[dwSize+1];
if (!pszOutBuffer)
{
printf("Out of memory\n");
dwSize=0;
}
else
{
// Read the Data.
ZeroMemory(pszOutBuffer, dwSize+1);
if (!WinHttpReadData( hRequest, (LPVOID)pszOutBuffer,
dwSize, &dwDownloaded))
printf( "Error %u in WinHttpReadData.\n", GetLastError());
else
printf( "%s\n", pszOutBuffer);
// Free the memory allocated to the buffer.
delete [] pszOutBuffer;
}
} while (dwSize > 0);
// Report any errors.
if (!bResults)
printf( "Error %d has occurred.\n", GetLastError());
// Close open handles.
if (hRequest) WinHttpCloseHandle(hRequest);
if (hConnect) WinHttpCloseHandle(hConnect);
if (hSession) WinHttpCloseHandle(hSession);
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WINHTTP.dll
#include <windows.h>
BOOL WinHttpQueryDataAvailable(
void* hRequest,
DWORD* lpdwNumberOfBytesAvailable
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpQueryDataAvailable(
IntPtr hRequest, // void* in/out
ref uint lpdwNumberOfBytesAvailable // DWORD* in/out
);<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpQueryDataAvailable(
hRequest As IntPtr, ' void* in/out
ByRef lpdwNumberOfBytesAvailable As UInteger ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hRequest : void* in/out
' lpdwNumberOfBytesAvailable : DWORD* in/out
Declare PtrSafe Function WinHttpQueryDataAvailable Lib "winhttp" ( _
ByVal hRequest As LongPtr, _
ByRef lpdwNumberOfBytesAvailable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WinHttpQueryDataAvailable = ctypes.windll.winhttp.WinHttpQueryDataAvailable
WinHttpQueryDataAvailable.restype = wintypes.BOOL
WinHttpQueryDataAvailable.argtypes = [
ctypes.POINTER(None), # hRequest : void* in/out
ctypes.POINTER(wintypes.DWORD), # lpdwNumberOfBytesAvailable : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpQueryDataAvailable = Fiddle::Function.new(
lib['WinHttpQueryDataAvailable'],
[
Fiddle::TYPE_VOIDP, # hRequest : void* in/out
Fiddle::TYPE_VOIDP, # lpdwNumberOfBytesAvailable : DWORD* in/out
],
Fiddle::TYPE_INT)#[link(name = "winhttp")]
extern "system" {
fn WinHttpQueryDataAvailable(
hRequest: *mut (), // void* in/out
lpdwNumberOfBytesAvailable: *mut u32 // DWORD* in/out
) -> 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 WinHttpQueryDataAvailable(IntPtr hRequest, ref uint lpdwNumberOfBytesAvailable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpQueryDataAvailable' -Namespace Win32 -PassThru
# $api::WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable)#uselib "WINHTTP.dll"
#func global WinHttpQueryDataAvailable "WinHttpQueryDataAvailable" sptr, sptr
; WinHttpQueryDataAvailable hRequest, varptr(lpdwNumberOfBytesAvailable) ; 戻り値は stat
; hRequest : void* in/out -> "sptr"
; lpdwNumberOfBytesAvailable : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WINHTTP.dll" #cfunc global WinHttpQueryDataAvailable "WinHttpQueryDataAvailable" sptr, var ; res = WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable) ; hRequest : void* in/out -> "sptr" ; lpdwNumberOfBytesAvailable : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINHTTP.dll" #cfunc global WinHttpQueryDataAvailable "WinHttpQueryDataAvailable" sptr, sptr ; res = WinHttpQueryDataAvailable(hRequest, varptr(lpdwNumberOfBytesAvailable)) ; hRequest : void* in/out -> "sptr" ; lpdwNumberOfBytesAvailable : DWORD* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL WinHttpQueryDataAvailable(void* hRequest, DWORD* lpdwNumberOfBytesAvailable) #uselib "WINHTTP.dll" #cfunc global WinHttpQueryDataAvailable "WinHttpQueryDataAvailable" intptr, var ; res = WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable) ; hRequest : void* in/out -> "intptr" ; lpdwNumberOfBytesAvailable : DWORD* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL WinHttpQueryDataAvailable(void* hRequest, DWORD* lpdwNumberOfBytesAvailable) #uselib "WINHTTP.dll" #cfunc global WinHttpQueryDataAvailable "WinHttpQueryDataAvailable" intptr, intptr ; res = WinHttpQueryDataAvailable(hRequest, varptr(lpdwNumberOfBytesAvailable)) ; hRequest : void* in/out -> "intptr" ; lpdwNumberOfBytesAvailable : DWORD* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
procWinHttpQueryDataAvailable = winhttp.NewProc("WinHttpQueryDataAvailable")
)
// hRequest (void* in/out), lpdwNumberOfBytesAvailable (DWORD* in/out)
r1, _, err := procWinHttpQueryDataAvailable.Call(
uintptr(hRequest),
uintptr(lpdwNumberOfBytesAvailable),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction WinHttpQueryDataAvailable(
hRequest: Pointer; // void* in/out
lpdwNumberOfBytesAvailable: Pointer // DWORD* in/out
): BOOL; stdcall;
external 'WINHTTP.dll' name 'WinHttpQueryDataAvailable';result := DllCall("WINHTTP\WinHttpQueryDataAvailable"
, "Ptr", hRequest ; void* in/out
, "Ptr", lpdwNumberOfBytesAvailable ; DWORD* in/out
, "Int") ; return: BOOL●WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable) = DLL("WINHTTP.dll", "bool WinHttpQueryDataAvailable(void*, void*)")
# 呼び出し: WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable)
# hRequest : void* in/out -> "void*"
# lpdwNumberOfBytesAvailable : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "winhttp" fn WinHttpQueryDataAvailable(
hRequest: ?*anyopaque, // void* in/out
lpdwNumberOfBytesAvailable: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;proc WinHttpQueryDataAvailable(
hRequest: pointer, # void* in/out
lpdwNumberOfBytesAvailable: ptr uint32 # DWORD* in/out
): int32 {.importc: "WinHttpQueryDataAvailable", stdcall, dynlib: "WINHTTP.dll".}pragma(lib, "winhttp");
extern(Windows)
int WinHttpQueryDataAvailable(
void* hRequest, // void* in/out
uint* lpdwNumberOfBytesAvailable // DWORD* in/out
);ccall((:WinHttpQueryDataAvailable, "WINHTTP.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt32}),
hRequest, lpdwNumberOfBytesAvailable)
# hRequest : void* in/out -> Ptr{Cvoid}
# lpdwNumberOfBytesAvailable : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpQueryDataAvailable(
void* hRequest,
uint32_t* lpdwNumberOfBytesAvailable);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable)
-- hRequest : void* in/out
-- lpdwNumberOfBytesAvailable : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpQueryDataAvailable = lib.func('__stdcall', 'WinHttpQueryDataAvailable', 'int32_t', ['void *', 'uint32_t *']);
// WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable)
// hRequest : void* in/out -> 'void *'
// lpdwNumberOfBytesAvailable : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINHTTP.dll", {
WinHttpQueryDataAvailable: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable)
// hRequest : void* in/out -> "pointer"
// lpdwNumberOfBytesAvailable : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpQueryDataAvailable(
void* hRequest,
uint32_t* lpdwNumberOfBytesAvailable);
C, "WINHTTP.dll");
// $ffi->WinHttpQueryDataAvailable(hRequest, lpdwNumberOfBytesAvailable);
// hRequest : void* in/out
// lpdwNumberOfBytesAvailable : DWORD* in/out
// 構造体/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 WinHttpQueryDataAvailable(
Pointer hRequest, // void* in/out
IntByReference lpdwNumberOfBytesAvailable // DWORD* in/out
);
}@[Link("winhttp")]
lib LibWINHTTP
fun WinHttpQueryDataAvailable = WinHttpQueryDataAvailable(
hRequest : Void*, # void* in/out
lpdwNumberOfBytesAvailable : UInt32* # DWORD* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WinHttpQueryDataAvailableNative = Int32 Function(Pointer<Void>, Pointer<Uint32>);
typedef WinHttpQueryDataAvailableDart = int Function(Pointer<Void>, Pointer<Uint32>);
final WinHttpQueryDataAvailable = DynamicLibrary.open('WINHTTP.dll')
.lookupFunction<WinHttpQueryDataAvailableNative, WinHttpQueryDataAvailableDart>('WinHttpQueryDataAvailable');
// hRequest : void* in/out -> Pointer<Void>
// lpdwNumberOfBytesAvailable : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WinHttpQueryDataAvailable(
hRequest: Pointer; // void* in/out
lpdwNumberOfBytesAvailable: Pointer // DWORD* in/out
): BOOL; stdcall;
external 'WINHTTP.dll' name 'WinHttpQueryDataAvailable';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WinHttpQueryDataAvailable"
c_WinHttpQueryDataAvailable :: Ptr () -> Ptr Word32 -> IO CInt
-- hRequest : void* in/out -> Ptr ()
-- lpdwNumberOfBytesAvailable : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let winhttpquerydataavailable =
foreign "WinHttpQueryDataAvailable"
((ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hRequest : void* in/out -> (ptr void) *)
(* lpdwNumberOfBytesAvailable : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)
(cffi:defcfun ("WinHttpQueryDataAvailable" win-http-query-data-available :convention :stdcall) :int32
(h-request :pointer) ; void* in/out
(lpdw-number-of-bytes-available :pointer)) ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WinHttpQueryDataAvailable = Win32::API::More->new('WINHTTP',
'BOOL WinHttpQueryDataAvailable(LPVOID hRequest, LPVOID lpdwNumberOfBytesAvailable)');
# my $ret = $WinHttpQueryDataAvailable->Call($hRequest, $lpdwNumberOfBytesAvailable);
# hRequest : void* in/out -> LPVOID
# lpdwNumberOfBytesAvailable : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WinHttpCloseHandle — WinHTTPハンドルを閉じてリソースを解放する。
- f WinHttpConnect — 指定サーバーへの接続を確立し接続ハンドルを返す。
- f WinHttpOpen — WinHTTPセッションを初期化しセッションハンドルを返す。
- f WinHttpOpenRequest — HTTP要求ハンドルを作成する。
- f WinHttpReadData — HTTP応答からデータをバッファへ読み取る。
- f WinHttpSendRequest — HTTP要求をサーバーへ送信する。