ホーム › Networking.WinInet › ReadUrlCacheEntryStream

ReadUrlCacheEntryStream

関数

URLキャッシュストリームから指定位置のデータを読み取る。

DLLWININET.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL ReadUrlCacheEntryStream(
    HANDLE hUrlCacheStream,
    DWORD dwLocation,
    void* lpBuffer,
    DWORD* lpdwLen,
    DWORD Reserved   // optional
);

パラメーター

名前	型	方向	説明
hUrlCacheStream	HANDLE	in	RetrieveUrlCacheEntryStream 関数によって返されたハンドルです。
dwLocation	DWORD	in	読み取りを開始するオフセットです。
lpBuffer	void*	out	データを受け取るバッファーへのポインターです。
lpdwLen	DWORD*	inout	lpBuffer バッファーのサイズ(バイト単位)を指定する変数へのポインターです。関数が返るとき、この変数にはバッファーにコピーされたバイト数、または必要なバッファーのサイズ(バイト単位)が格納されます。
Reserved	DWORD	optional	このパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

RetrieveUrlCacheEntryStream 関数を使用して開いたストリームから、キャッシュされたデータを読み取ります。

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

バッファーサイズが不十分な場合、 GetLastError は ERROR_INSUFFICIENT_BUFFER を返し、 lpdwLen にすべての情報を格納するために必要なサイズを設定します。

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

Note 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 ReadUrlCacheEntryStream(
    HANDLE hUrlCacheStream,
    DWORD dwLocation,
    void* lpBuffer,
    DWORD* lpdwLen,
    DWORD Reserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadUrlCacheEntryStream(
    IntPtr hUrlCacheStream,   // HANDLE
    uint dwLocation,   // DWORD
    IntPtr lpBuffer,   // void* out
    ref uint lpdwLen,   // DWORD* in/out
    uint Reserved   // DWORD optional
);

<DllImport("WININET.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadUrlCacheEntryStream(
    hUrlCacheStream As IntPtr,   ' HANDLE
    dwLocation As UInteger,   ' DWORD
    lpBuffer As IntPtr,   ' void* out
    ByRef lpdwLen As UInteger,   ' DWORD* in/out
    Reserved As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hUrlCacheStream : HANDLE
' dwLocation : DWORD
' lpBuffer : void* out
' lpdwLen : DWORD* in/out
' Reserved : DWORD optional
Declare PtrSafe Function ReadUrlCacheEntryStream Lib "wininet" ( _
    ByVal hUrlCacheStream As LongPtr, _
    ByVal dwLocation As Long, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpdwLen As Long, _
    ByVal Reserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadUrlCacheEntryStream = ctypes.windll.wininet.ReadUrlCacheEntryStream
ReadUrlCacheEntryStream.restype = wintypes.BOOL
ReadUrlCacheEntryStream.argtypes = [
    wintypes.HANDLE,  # hUrlCacheStream : HANDLE
    wintypes.DWORD,  # dwLocation : DWORD
    ctypes.POINTER(None),  # lpBuffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # lpdwLen : DWORD* in/out
    wintypes.DWORD,  # Reserved : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
ReadUrlCacheEntryStream = Fiddle::Function.new(
  lib['ReadUrlCacheEntryStream'],
  [
    Fiddle::TYPE_VOIDP,  # hUrlCacheStream : HANDLE
    -Fiddle::TYPE_INT,  # dwLocation : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    Fiddle::TYPE_VOIDP,  # lpdwLen : DWORD* in/out
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn ReadUrlCacheEntryStream(
        hUrlCacheStream: *mut core::ffi::c_void,  // HANDLE
        dwLocation: u32,  // DWORD
        lpBuffer: *mut (),  // void* out
        lpdwLen: *mut u32,  // DWORD* in/out
        Reserved: u32  // DWORD 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 ReadUrlCacheEntryStream(IntPtr hUrlCacheStream, uint dwLocation, IntPtr lpBuffer, ref uint lpdwLen, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_ReadUrlCacheEntryStream' -Namespace Win32 -PassThru
# $api::ReadUrlCacheEntryStream(hUrlCacheStream, dwLocation, lpBuffer, lpdwLen, Reserved)

#uselib "WININET.dll"
#func global ReadUrlCacheEntryStream "ReadUrlCacheEntryStream" sptr, sptr, sptr, sptr, sptr
; ReadUrlCacheEntryStream hUrlCacheStream, dwLocation, lpBuffer, varptr(lpdwLen), Reserved   ; 戻り値は stat
; hUrlCacheStream : HANDLE -> "sptr"
; dwLocation : DWORD -> "sptr"
; lpBuffer : void* out -> "sptr"
; lpdwLen : DWORD* in/out -> "sptr"
; Reserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global ReadUrlCacheEntryStream "ReadUrlCacheEntryStream" sptr, int, sptr, var, int
; res = ReadUrlCacheEntryStream(hUrlCacheStream, dwLocation, lpBuffer, lpdwLen, Reserved)
; hUrlCacheStream : HANDLE -> "sptr"
; dwLocation : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; lpdwLen : DWORD* in/out -> "var"
; Reserved : DWORD optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global ReadUrlCacheEntryStream "ReadUrlCacheEntryStream" sptr, int, sptr, sptr, int
; res = ReadUrlCacheEntryStream(hUrlCacheStream, dwLocation, lpBuffer, varptr(lpdwLen), Reserved)
; hUrlCacheStream : HANDLE -> "sptr"
; dwLocation : DWORD -> "int"
; lpBuffer : void* out -> "sptr"
; lpdwLen : DWORD* in/out -> "sptr"
; Reserved : DWORD optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。