Win32 API 日本語リファレンス
ホームNetworking.WinInet › InternetQueryDataAvailable

InternetQueryDataAvailable

関数
読み取り可能なデータのバイト数を問い合わせる。
DLLWININET.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll
#include <windows.h>

BOOL InternetQueryDataAvailable(
    void* hFile,
    DWORD* lpdwNumberOfBytesAvailable,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前方向説明
hFilevoid*inInternetOpenUrlFtpOpenFileGopherOpenFile、または HttpOpenRequest 関数によって返されたハンドルです。
lpdwNumberOfBytesAvailableDWORD*outoptional利用可能なバイト数を受け取る変数へのポインターです。NULL でもかまいません。
dwFlagsDWORDinこのパラメーターは予約されており、0 を指定する必要があります。
dwContextUINT_PTRinoptionalこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

サーバーに問い合わせて、利用可能なデータ量を取得します。

戻り値

関数が成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。関数が一致するファイルを見つけられなかった場合、GetLastErrorERROR_NO_MORE_FILES を返します。

解説(Remarks)

この関数は、その後の InternetReadFile の呼び出しによって即座に読み取り可能なデータのバイト数を返します。現在利用可能なデータがなく、ファイルの末尾に到達していない場合、要求はデータが利用可能になるまで待機します。残りのデータ量は、InternetQueryDataAvailable の呼び出しで示されたすべての利用可能なデータが読み取られるまで再計算されません。

HttpOpenRequest によって作成され HttpSendRequestEx によって送信された HINTERNET ハンドルの場合、InternetQueryDataAvailable を使用する前に、そのハンドルに対して HttpEndRequest を呼び出す必要があります。

WinINet API の他のすべての側面と同様に、この関数は DllMain 内やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WININET.dll
#include <windows.h>

BOOL InternetQueryDataAvailable(
    void* hFile,
    DWORD* lpdwNumberOfBytesAvailable,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InternetQueryDataAvailable(
    IntPtr hFile,   // void*
    IntPtr lpdwNumberOfBytesAvailable,   // DWORD* optional, out
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);
<DllImport("WININET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetQueryDataAvailable(
    hFile As IntPtr,   ' void*
    lpdwNumberOfBytesAvailable As IntPtr,   ' DWORD* optional, out
    dwFlags As UInteger,   ' DWORD
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFile : void*
' lpdwNumberOfBytesAvailable : DWORD* optional, out
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function InternetQueryDataAvailable Lib "wininet" ( _
    ByVal hFile As LongPtr, _
    ByVal lpdwNumberOfBytesAvailable As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternetQueryDataAvailable = ctypes.windll.wininet.InternetQueryDataAvailable
InternetQueryDataAvailable.restype = wintypes.BOOL
InternetQueryDataAvailable.argtypes = [
    ctypes.POINTER(None),  # hFile : void*
    ctypes.POINTER(wintypes.DWORD),  # lpdwNumberOfBytesAvailable : DWORD* optional, out
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetQueryDataAvailable = Fiddle::Function.new(
  lib['InternetQueryDataAvailable'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : void*
    Fiddle::TYPE_VOIDP,  # lpdwNumberOfBytesAvailable : DWORD* optional, out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wininet")]
extern "system" {
    fn InternetQueryDataAvailable(
        hFile: *mut (),  // void*
        lpdwNumberOfBytesAvailable: *mut u32,  // DWORD* optional, out
        dwFlags: u32,  // DWORD
        dwContext: usize  // UINT_PTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true)]
public static extern bool InternetQueryDataAvailable(IntPtr hFile, IntPtr lpdwNumberOfBytesAvailable, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetQueryDataAvailable' -Namespace Win32 -PassThru
# $api::InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
#uselib "WININET.dll"
#func global InternetQueryDataAvailable "InternetQueryDataAvailable" sptr, sptr, sptr, sptr
; InternetQueryDataAvailable hFile, varptr(lpdwNumberOfBytesAvailable), dwFlags, dwContext   ; 戻り値は stat
; hFile : void* -> "sptr"
; lpdwNumberOfBytesAvailable : DWORD* optional, out -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global InternetQueryDataAvailable "InternetQueryDataAvailable" sptr, var, int, sptr
; res = InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
; hFile : void* -> "sptr"
; lpdwNumberOfBytesAvailable : DWORD* optional, out -> "var"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL InternetQueryDataAvailable(void* hFile, DWORD* lpdwNumberOfBytesAvailable, DWORD dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global InternetQueryDataAvailable "InternetQueryDataAvailable" intptr, var, int, intptr
; res = InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
; hFile : void* -> "intptr"
; lpdwNumberOfBytesAvailable : DWORD* optional, out -> "var"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procInternetQueryDataAvailable = wininet.NewProc("InternetQueryDataAvailable")
)

// hFile (void*), lpdwNumberOfBytesAvailable (DWORD* optional, out), dwFlags (DWORD), dwContext (UINT_PTR optional)
r1, _, err := procInternetQueryDataAvailable.Call(
	uintptr(hFile),
	uintptr(lpdwNumberOfBytesAvailable),
	uintptr(dwFlags),
	uintptr(dwContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function InternetQueryDataAvailable(
  hFile: Pointer;   // void*
  lpdwNumberOfBytesAvailable: Pointer;   // DWORD* optional, out
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetQueryDataAvailable';
result := DllCall("WININET\InternetQueryDataAvailable"
    , "Ptr", hFile   ; void*
    , "Ptr", lpdwNumberOfBytesAvailable   ; DWORD* optional, out
    , "UInt", dwFlags   ; DWORD
    , "UPtr", dwContext   ; UINT_PTR optional
    , "Int")   ; return: BOOL
●InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext) = DLL("WININET.dll", "bool InternetQueryDataAvailable(void*, void*, dword, int)")
# 呼び出し: InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
# hFile : void* -> "void*"
# lpdwNumberOfBytesAvailable : DWORD* optional, out -> "void*"
# dwFlags : DWORD -> "dword"
# dwContext : UINT_PTR optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wininet" fn InternetQueryDataAvailable(
    hFile: ?*anyopaque, // void*
    lpdwNumberOfBytesAvailable: [*c]u32, // DWORD* optional, out
    dwFlags: u32, // DWORD
    dwContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) i32;
proc InternetQueryDataAvailable(
    hFile: pointer,  # void*
    lpdwNumberOfBytesAvailable: ptr uint32,  # DWORD* optional, out
    dwFlags: uint32,  # DWORD
    dwContext: uint  # UINT_PTR optional
): int32 {.importc: "InternetQueryDataAvailable", stdcall, dynlib: "WININET.dll".}
pragma(lib, "wininet");
extern(Windows)
int InternetQueryDataAvailable(
    void* hFile,   // void*
    uint* lpdwNumberOfBytesAvailable,   // DWORD* optional, out
    uint dwFlags,   // DWORD
    size_t dwContext   // UINT_PTR optional
);
ccall((:InternetQueryDataAvailable, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}, UInt32, Csize_t),
      hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
# hFile : void* -> Ptr{Cvoid}
# lpdwNumberOfBytesAvailable : DWORD* optional, out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# dwContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InternetQueryDataAvailable(
    void* hFile,
    uint32_t* lpdwNumberOfBytesAvailable,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
-- hFile : void*
-- lpdwNumberOfBytesAvailable : DWORD* optional, out
-- dwFlags : DWORD
-- dwContext : UINT_PTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const InternetQueryDataAvailable = lib.func('__stdcall', 'InternetQueryDataAvailable', 'int32_t', ['void *', 'uint32_t *', 'uint32_t', 'uintptr_t']);
// InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
// hFile : void* -> 'void *'
// lpdwNumberOfBytesAvailable : DWORD* optional, out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// dwContext : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  InternetQueryDataAvailable: { parameters: ["pointer", "pointer", "u32", "usize"], result: "i32" },
});
// lib.symbols.InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext)
// hFile : void* -> "pointer"
// lpdwNumberOfBytesAvailable : DWORD* optional, out -> "pointer"
// dwFlags : DWORD -> "u32"
// dwContext : UINT_PTR optional -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InternetQueryDataAvailable(
    void* hFile,
    uint32_t* lpdwNumberOfBytesAvailable,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->InternetQueryDataAvailable(hFile, lpdwNumberOfBytesAvailable, dwFlags, dwContext);
// hFile : void*
// lpdwNumberOfBytesAvailable : DWORD* optional, out
// dwFlags : DWORD
// dwContext : UINT_PTR optional
// 構造体/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 Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class);
    boolean InternetQueryDataAvailable(
        Pointer hFile,   // void*
        IntByReference lpdwNumberOfBytesAvailable,   // DWORD* optional, out
        int dwFlags,   // DWORD
        long dwContext   // UINT_PTR optional
    );
}
@[Link("wininet")]
lib LibWININET
  fun InternetQueryDataAvailable = InternetQueryDataAvailable(
    hFile : Void*,   # void*
    lpdwNumberOfBytesAvailable : UInt32*,   # DWORD* optional, out
    dwFlags : UInt32,   # DWORD
    dwContext : LibC::SizeT   # UINT_PTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternetQueryDataAvailableNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Uint32, UintPtr);
typedef InternetQueryDataAvailableDart = int Function(Pointer<Void>, Pointer<Uint32>, int, int);
final InternetQueryDataAvailable = DynamicLibrary.open('WININET.dll')
    .lookupFunction<InternetQueryDataAvailableNative, InternetQueryDataAvailableDart>('InternetQueryDataAvailable');
// hFile : void* -> Pointer<Void>
// lpdwNumberOfBytesAvailable : DWORD* optional, out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// dwContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternetQueryDataAvailable(
  hFile: Pointer;   // void*
  lpdwNumberOfBytesAvailable: Pointer;   // DWORD* optional, out
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'InternetQueryDataAvailable';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternetQueryDataAvailable"
  c_InternetQueryDataAvailable :: Ptr () -> Ptr Word32 -> Word32 -> CUIntPtr -> IO CInt
-- hFile : void* -> Ptr ()
-- lpdwNumberOfBytesAvailable : DWORD* optional, out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- dwContext : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internetquerydataavailable =
  foreign "InternetQueryDataAvailable"
    ((ptr void) @-> (ptr uint32_t) @-> uint32_t @-> size_t @-> returning int32_t)
(* hFile : void* -> (ptr void) *)
(* lpdwNumberOfBytesAvailable : DWORD* optional, out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* dwContext : UINT_PTR optional -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("InternetQueryDataAvailable" internet-query-data-available :convention :stdcall) :int32
  (h-file :pointer)   ; void*
  (lpdw-number-of-bytes-available :pointer)   ; DWORD* optional, out
  (dw-flags :uint32)   ; DWORD
  (dw-context :uint64))   ; UINT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternetQueryDataAvailable = Win32::API::More->new('WININET',
    'BOOL InternetQueryDataAvailable(LPVOID hFile, LPVOID lpdwNumberOfBytesAvailable, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $InternetQueryDataAvailable->Call($hFile, $lpdwNumberOfBytesAvailable, $dwFlags, $dwContext);
# hFile : void* -> LPVOID
# lpdwNumberOfBytesAvailable : DWORD* optional, out -> LPVOID
# dwFlags : DWORD -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。