ホーム › Networking.WinInet › RetrieveUrlCacheEntryFileA

RetrieveUrlCacheEntryFileA

関数

URLキャッシュエントリのファイルを取得しロックする(ANSI版)。

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

シグネチャ

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

BOOL RetrieveUrlCacheEntryFileA(
    LPCSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,
    DWORD dwReserved   // optional
);

パラメーター

名前	型	方向	説明
lpszUrlName	LPCSTR	in	キャッシュエントリに関連付けられたリソースの URL を格納する文字列へのポインターです。これは一意な名前でなければなりません。名前の文字列にはエスケープ文字を含めないでください。
lpCacheEntryInfo	INTERNET_CACHE_ENTRY_INFOA*	inoutoptional	キャッシュエントリ情報バッファーへのポインターです。バッファーが十分でない場合、この関数は ERROR_INSUFFICIENT_BUFFER を返し、 lpdwCacheEntryInfoBufferSize に必要なバイト数を設定します。
lpcbCacheEntryInfo	DWORD*	inout	lpCacheEntryInfo バッファーのサイズをバイト単位で指定する符号なし long 整数変数へのポインターです。関数が戻るとき、この変数には実際に使用されたバッファーのサイズ、またはキャッシュエントリファイルを取得するために必要なバイト数がバイト単位で格納されます。呼び出し側はこのパラメーターの戻り値を確認する必要があります。戻りサイズが渡したサイズ以下であれば、関連するすべてのデータが返されています。
dwReserved	DWORD	optional	このパラメーターは予約済みであり、0 でなければなりません。

戻り値の型: BOOL

公式ドキュメント

指定された URL に関連付けられたキャッシュエントリファイルをロックします。(ANSI)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。考えられるエラー値には次のものがあります。

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

解説(Remarks)

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

ファイルは取得されると呼び出し側のためにロックされます。呼び出し側はファイルの使用を終えた後、ファイルのロックを解除する必要があります。キャッシュマネージャーは一定の間隔の後に自動的にファイルのロックを解除します。ファイルがロックされている間、キャッシュマネージャーはそのファイルをキャッシュから削除しません。この関数が効率的に動作するかどうかは、キャッシュの内部実装によって異なる点に注意することが重要です。たとえば、URL のデータが他の URL のデータを含むパックファイルに格納されている場合、キャッシュはそのデータのコピーを、キャッシュが管理する一時ディレクトリ内のファイルに作成します。キャッシュは最終的にそのコピーを削除します。この関数は、アプリケーションを起動するためにファイル名が必要な状況でのみ使用することを推奨します。ほとんどの場合は RetrieveUrlCacheEntryStream および関連するストリーム関数を使用してください。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL RetrieveUrlCacheEntryFileA(
    LPCSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,
    DWORD dwReserved   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

RetrieveUrlCacheEntryFileA = ctypes.windll.wininet.RetrieveUrlCacheEntryFileA
RetrieveUrlCacheEntryFileA.restype = wintypes.BOOL
RetrieveUrlCacheEntryFileA.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.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')
RetrieveUrlCacheEntryFileA = Fiddle::Function.new(
  lib['RetrieveUrlCacheEntryFileA'],
  [
    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,  # dwReserved : DWORD optional
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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