ホーム › Networking.WinInet › GetUrlCacheEntryInfoW

GetUrlCacheEntryInfoW

関数

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

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

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL GetUrlCacheEntryInfoW(
    LPCWSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOW* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo   // optional
);

パラメーター

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

名前

型

方向

説明

lpszUrlName

LPCWSTR

キャッシュエントリの名前を含む null 終端文字列へのポインターです。名前の文字列にはエスケープ文字を含めないでください。

lpCacheEntryInfo

INTERNET_CACHE_ENTRY_INFOW*

inoutoptional

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

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

lpcbCacheEntryInfo

DWORD*

inoutoptional

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

成功した場合は 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 ヘッダーは GetUrlCacheEntryInfo を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL GetUrlCacheEntryInfoW(
    LPCWSTR lpszUrlName,
    INTERNET_CACHE_ENTRY_INFOW* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetUrlCacheEntryInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName,   // LPCWSTR
    IntPtr lpCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    IntPtr lpcbCacheEntryInfo   // DWORD* optional, in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUrlCacheEntryInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrlName As String,   ' LPCWSTR
    lpCacheEntryInfo As IntPtr,   ' INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    lpcbCacheEntryInfo As IntPtr   ' DWORD* optional, in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrlName : LPCWSTR
' lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
' lpcbCacheEntryInfo : DWORD* optional, in/out
Declare PtrSafe Function GetUrlCacheEntryInfoW Lib "wininet" ( _
    ByVal lpszUrlName As LongPtr, _
    ByVal lpCacheEntryInfo As LongPtr, _
    ByVal lpcbCacheEntryInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetUrlCacheEntryInfoW = ctypes.windll.wininet.GetUrlCacheEntryInfoW
GetUrlCacheEntryInfoW.restype = wintypes.BOOL
GetUrlCacheEntryInfoW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrlName : LPCWSTR
    ctypes.c_void_p,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* 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')
GetUrlCacheEntryInfoW = Fiddle::Function.new(
  lib['GetUrlCacheEntryInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheEntryInfo : DWORD* optional, in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn GetUrlCacheEntryInfoW(
        lpszUrlName: *const u16,  // LPCWSTR
        lpCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOW,  // INTERNET_CACHE_ENTRY_INFOW* 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.Unicode, SetLastError = true)]
public static extern bool GetUrlCacheEntryInfoW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrlName, IntPtr lpCacheEntryInfo, IntPtr lpcbCacheEntryInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GetUrlCacheEntryInfoW' -Namespace Win32 -PassThru
# $api::GetUrlCacheEntryInfoW(lpszUrlName, lpCacheEntryInfo, lpcbCacheEntryInfo)

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

出力引数:

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