ホーム › Networking.WinInet › RetrieveUrlCacheEntryStreamA

RetrieveUrlCacheEntryStreamA

関数

URLキャッシュエントリをストリームとして開く(ANSI版)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

HANDLE RetrieveUrlCacheEntryStreamA(
    LPCSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,
    BOOL fRandomRead,
    DWORD dwReserved   // optional
);

パラメーター

名前	型	方向	説明
lpszUrlName	LPCSTR	in	キャッシュエントリのソース名を含む、null で終わる文字列へのポインターです。これは一意の名前である必要があります。名前の文字列にエスケープ文字を含めることはできません。
lpCacheEntryInfo	INTERNET_CACHE_ENTRY_INFOA*	inoutoptional	キャッシュエントリに関する情報を受け取る INTERNET_CACHE_ENTRY_INFO 構造体へのポインターです。
lpcbCacheEntryInfo	DWORD*	inout	lpCacheEntryInfo バッファーのサイズ(バイト単位)を指定する変数へのポインターです。関数が返ると、この変数にはバッファーへコピーされたバイト数、または必要なバッファーサイズ(バイト単位)が格納されます。なお、このバッファーサイズは、INTERNET_CACHE_ENTRY_INFO 構造体と、その直後に格納される関連文字列の両方を収容できる大きさである必要があります。
fRandomRead	BOOL	in	ストリームをランダムアクセス用に開くかどうかを指定します。ストリームをランダムアクセス用に開くには、このフラグを TRUE に設定します。
dwReserved	DWORD	optional	このパラメーターは予約されており、0 である必要があります。

戻り値の型: HANDLE

公式ドキュメント

キャッシュデータにアクセスするための、最も効率的で実装に依存しない方法を提供します。(ANSI)

戻り値

関数が成功すると、 ReadUrlCacheEntryStream 関数および UnlockUrlCacheEntryStream 関数で使用できる有効なハンドルを返します。

関数が失敗すると、NULL を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

発生し得るエラー値には次のものが含まれます。

戻り値	説明
ERROR_FILE_NOT_FOUND	ソース名で指定されたキャッシュエントリがキャッシュストレージ内に見つかりません。
ERROR_INSUFFICIENT_BUFFER	lpdwCacheEntryInfoBufferSize で指定された lpCacheEntryInfo のサイズが、すべての情報を格納するには不十分です。 lpdwCacheEntryInfoBufferSize に返される値は、すべての情報を格納するために必要なバッファーサイズを示します。

解説(Remarks)

RetrieveUrlCacheEntryStream は URL の解析を一切行わないため、アンカー(#)を含む URL は、たとえそのリソースがキャッシュされていてもキャッシュ内では見つかりません。たとえば、URL http://adatum.com/example.htm#sample が渡された場合、http://adatum.com/example.htm がキャッシュ内に存在していても、この関数は ERROR_FILE_NOT_FOUND を返します。

ファイル形式の URL データを必要としないキャッシュクライアントは、特定の URL のデータにアクセスするためにこの関数を使用してください。

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

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用することも避けてください。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RetrieveUrlCacheEntryStream を定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

HANDLE RetrieveUrlCacheEntryStreamA(
    LPCSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,
    BOOL fRandomRead,
    DWORD dwReserved   // optional
);

[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr RetrieveUrlCacheEntryStreamA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrlName,   // LPCSTR
    IntPtr lpCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    ref uint lpcbCacheEntryInfo,   // DWORD* in/out
    bool fRandomRead,   // BOOL
    uint dwReserved   // DWORD optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RetrieveUrlCacheEntryStreamA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrlName As String,   ' LPCSTR
    lpCacheEntryInfo As IntPtr,   ' INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    ByRef lpcbCacheEntryInfo As UInteger,   ' DWORD* in/out
    fRandomRead As Boolean,   ' BOOL
    dwReserved As UInteger   ' DWORD optional
) As IntPtr
End Function

' lpszUrlName : LPCSTR
' lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out
' lpcbCacheEntryInfo : DWORD* in/out
' fRandomRead : BOOL
' dwReserved : DWORD optional
Declare PtrSafe Function RetrieveUrlCacheEntryStreamA Lib "wininet" ( _
    ByVal lpszUrlName As String, _
    ByVal lpCacheEntryInfo As LongPtr, _
    ByRef lpcbCacheEntryInfo As Long, _
    ByVal fRandomRead As Long, _
    ByVal dwReserved As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RetrieveUrlCacheEntryStreamA = ctypes.windll.wininet.RetrieveUrlCacheEntryStreamA
RetrieveUrlCacheEntryStreamA.restype = ctypes.c_void_p
RetrieveUrlCacheEntryStreamA.argtypes = [
    wintypes.LPCSTR,  # lpszUrlName : LPCSTR
    ctypes.c_void_p,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpcbCacheEntryInfo : DWORD* in/out
    wintypes.BOOL,  # fRandomRead : BOOL
    wintypes.DWORD,  # dwReserved : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
RetrieveUrlCacheEntryStreamA = Fiddle::Function.new(
  lib['RetrieveUrlCacheEntryStreamA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheEntryInfo : DWORD* in/out
    Fiddle::TYPE_INT,  # fRandomRead : BOOL
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "wininet")]
extern "system" {
    fn RetrieveUrlCacheEntryStreamA(
        lpszUrlName: *const u8,  // LPCSTR
        lpCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOA,  // INTERNET_CACHE_ENTRY_INFOA* optional, in/out
        lpcbCacheEntryInfo: *mut u32,  // DWORD* in/out
        fRandomRead: i32,  // BOOL
        dwReserved: u32  // DWORD optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr RetrieveUrlCacheEntryStreamA([MarshalAs(UnmanagedType.LPStr)] string lpszUrlName, IntPtr lpCacheEntryInfo, ref uint lpcbCacheEntryInfo, bool fRandomRead, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_RetrieveUrlCacheEntryStreamA' -Namespace Win32 -PassThru
# $api::RetrieveUrlCacheEntryStreamA(lpszUrlName, lpCacheEntryInfo, lpcbCacheEntryInfo, fRandomRead, dwReserved)

#uselib "WININET.dll"
#func global RetrieveUrlCacheEntryStreamA "RetrieveUrlCacheEntryStreamA" sptr, sptr, sptr, sptr, sptr
; RetrieveUrlCacheEntryStreamA lpszUrlName, varptr(lpCacheEntryInfo), varptr(lpcbCacheEntryInfo), fRandomRead, dwReserved   ; 戻り値は stat
; lpszUrlName : LPCSTR -> "sptr"
; lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out -> "sptr"
; lpcbCacheEntryInfo : DWORD* in/out -> "sptr"
; fRandomRead : BOOL -> "sptr"
; dwReserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global RetrieveUrlCacheEntryStreamA "RetrieveUrlCacheEntryStreamA" str, var, var, int, int
; res = RetrieveUrlCacheEntryStreamA(lpszUrlName, lpCacheEntryInfo, lpcbCacheEntryInfo, fRandomRead, dwReserved)
; lpszUrlName : LPCSTR -> "str"
; lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out -> "var"
; lpcbCacheEntryInfo : DWORD* in/out -> "var"
; fRandomRead : BOOL -> "int"
; dwReserved : DWORD optional -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global RetrieveUrlCacheEntryStreamA "RetrieveUrlCacheEntryStreamA" str, sptr, sptr, int, int
; res = RetrieveUrlCacheEntryStreamA(lpszUrlName, varptr(lpCacheEntryInfo), varptr(lpcbCacheEntryInfo), fRandomRead, dwReserved)
; lpszUrlName : LPCSTR -> "str"
; lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out -> "sptr"
; lpcbCacheEntryInfo : DWORD* in/out -> "sptr"
; fRandomRead : BOOL -> "int"
; dwReserved : DWORD optional -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。