ホーム › Networking.WinInet › GetUrlCacheEntryInfoA

GetUrlCacheEntryInfoA

関数

指定URLのキャッシュエントリ情報を取得する(ANSI版)。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
lpszUrlName	LPCSTR	in	キャッシュエントリの名前を含む、null で終端された文字列へのポインターです。名前の文字列にエスケープ文字を含めることはできません。
lpCacheEntryInfo	INTERNET_CACHE_ENTRY_INFOA*	inoutoptional	キャッシュエントリに関する情報を受け取る INTERNET_CACHE_ENTRY_INFO 構造体へのポインターです。このパラメーター用にバッファーを割り当てる必要があります。必要なバッファーサイズは事前にはわからないため、ほとんどの INTERNET_CACHE_ENTRY_INFO エントリのサイズを処理できる十分なバッファーを割り当てるのが最善です。キャッシュエントリのサイズに制限はないため、キャッシュを列挙する必要があるアプリケーションは、可変サイズのバッファーを割り当てられるように準備しておく必要があります。
lpcbCacheEntryInfo	DWORD*	inoutoptional	lpCacheEntryInfo バッファーのサイズをバイト単位で指定する変数へのポインターです。関数が戻るとき、この変数にはバッファーにコピーされたバイト数、または必要なバッファーのサイズ (バイト単位) が格納されます。

名前

型

方向

説明

lpszUrlName

LPCSTR

キャッシュエントリの名前を含む、null で終端された文字列へのポインターです。名前の文字列にエスケープ文字を含めることはできません。

lpCacheEntryInfo

INTERNET_CACHE_ENTRY_INFOA*

inoutoptional

キャッシュエントリに関する情報を受け取る INTERNET_CACHE_ENTRY_INFO 構造体へのポインターです。このパラメーター用にバッファーを割り当てる必要があります。

必要なバッファーサイズは事前にはわからないため、ほとんどの INTERNET_CACHE_ENTRY_INFO エントリのサイズを処理できる十分なバッファーを割り当てるのが最善です。キャッシュエントリのサイズに制限はないため、キャッシュを列挙する必要があるアプリケーションは、可変サイズのバッファーを割り当てられるように準備しておく必要があります。

lpcbCacheEntryInfo

DWORD*

inoutoptional

lpCacheEntryInfo バッファーのサイズをバイト単位で指定する変数へのポインターです。関数が戻るとき、この変数にはバッファーにコピーされたバイト数、または必要なバッファーのサイズ (バイト単位) が格納されます。

戻り値の型: BOOL

公式ドキュメント

キャッシュエントリに関する情報を取得します。(ANSI)

戻り値

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

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

解説(Remarks)

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetUrlCacheEntryInfoA(
    LPCSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "wininet")]
extern "system" {
    fn GetUrlCacheEntryInfoA(
        lpszUrlName: *const u8,  // LPCSTR
        lpCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOA,  // INTERNET_CACHE_ENTRY_INFOA* optional, in/out
        lpcbCacheEntryInfo: *mut u32  // DWORD* optional, in/out
    ) -> 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 GetUrlCacheEntryInfoA([MarshalAs(UnmanagedType.LPStr)] string lpszUrlName, IntPtr lpCacheEntryInfo, IntPtr lpcbCacheEntryInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GetUrlCacheEntryInfoA' -Namespace Win32 -PassThru
# $api::GetUrlCacheEntryInfoA(lpszUrlName, lpCacheEntryInfo, lpcbCacheEntryInfo)

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

出力引数:

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