ホーム › Networking.WinInet › GetUrlCacheEntryInfoExW

GetUrlCacheEntryInfoExW

関数

リダイレクト対応でURLキャッシュエントリ情報を取得する(Unicode版)。

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

シグネチャ

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

BOOL GetUrlCacheEntryInfoExW(
    LPCWSTR lpszUrl,
    INTERNET_CACHE_ENTRY_INFOW* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,   // optional
    LPWSTR lpszRedirectUrl,   // optional
    DWORD* lpcbRedirectUrl,   // optional
    void* lpReserved,   // optional
    DWORD dwFlags
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

指定された URL に関連付けられたキャッシュエントリの情報を取得します。HttpSendRequest 関数によってオフラインモードで適用されるリダイレクトも考慮されます。(Unicode)

戻り値

URL が見つかった場合は TRUE を、見つからなかった場合は FALSE を返します。具体的なエラー情報については GetLastError を呼び出してください。発生し得るエラーには次のものがあります。

戻り値	説明
ERROR_FILE_NOT_FOUND	キャッシュされたリダイレクトを考慮した後でも、URL がキャッシュインデックス内に見つかりませんでした。
ERROR_INSUFFICIENT_BUFFER	lpCacheEntryInfo が参照するバッファーが、要求された情報を格納するには十分な大きさではありませんでした。必要なバッファーサイズは lpdwCacheEntryInfoBufSize に返されます。

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetUrlCacheEntryInfoExW(
    LPCWSTR lpszUrl,
    INTERNET_CACHE_ENTRY_INFOW* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,   // optional
    LPWSTR lpszRedirectUrl,   // optional
    DWORD* lpcbRedirectUrl,   // optional
    void* lpReserved,   // optional
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetUrlCacheEntryInfoExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrl,   // LPCWSTR
    IntPtr lpCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    IntPtr lpcbCacheEntryInfo,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszRedirectUrl,   // LPWSTR optional
    IntPtr lpcbRedirectUrl,   // DWORD* optional
    IntPtr lpReserved,   // void* optional
    uint dwFlags   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUrlCacheEntryInfoExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrl As String,   ' LPCWSTR
    lpCacheEntryInfo As IntPtr,   ' INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    lpcbCacheEntryInfo As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPWStr)> lpszRedirectUrl As System.Text.StringBuilder,   ' LPWSTR optional
    lpcbRedirectUrl As IntPtr,   ' DWORD* optional
    lpReserved As IntPtr,   ' void* optional
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrl : LPCWSTR
' lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
' lpcbCacheEntryInfo : DWORD* optional, in/out
' lpszRedirectUrl : LPWSTR optional
' lpcbRedirectUrl : DWORD* optional
' lpReserved : void* optional
' dwFlags : DWORD
Declare PtrSafe Function GetUrlCacheEntryInfoExW Lib "wininet" ( _
    ByVal lpszUrl As LongPtr, _
    ByVal lpCacheEntryInfo As LongPtr, _
    ByVal lpcbCacheEntryInfo As LongPtr, _
    ByVal lpszRedirectUrl As LongPtr, _
    ByVal lpcbRedirectUrl As LongPtr, _
    ByVal lpReserved As LongPtr, _
    ByVal dwFlags As Long) 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

GetUrlCacheEntryInfoExW = ctypes.windll.wininet.GetUrlCacheEntryInfoExW
GetUrlCacheEntryInfoExW.restype = wintypes.BOOL
GetUrlCacheEntryInfoExW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrl : LPCWSTR
    ctypes.c_void_p,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpcbCacheEntryInfo : DWORD* optional, in/out
    wintypes.LPWSTR,  # lpszRedirectUrl : LPWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # lpcbRedirectUrl : DWORD* optional
    ctypes.POINTER(None),  # lpReserved : void* optional
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
GetUrlCacheEntryInfoExW = Fiddle::Function.new(
  lib['GetUrlCacheEntryInfoExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOW* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheEntryInfo : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpszRedirectUrl : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # lpcbRedirectUrl : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn GetUrlCacheEntryInfoExW(
        lpszUrl: *const u16,  // LPCWSTR
        lpCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOW,  // INTERNET_CACHE_ENTRY_INFOW* optional, in/out
        lpcbCacheEntryInfo: *mut u32,  // DWORD* optional, in/out
        lpszRedirectUrl: *mut u16,  // LPWSTR optional
        lpcbRedirectUrl: *mut u32,  // DWORD* optional
        lpReserved: *mut (),  // void* optional
        dwFlags: u32  // DWORD
    ) -> 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 GetUrlCacheEntryInfoExW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrl, IntPtr lpCacheEntryInfo, IntPtr lpcbCacheEntryInfo, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszRedirectUrl, IntPtr lpcbRedirectUrl, IntPtr lpReserved, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GetUrlCacheEntryInfoExW' -Namespace Win32 -PassThru
# $api::GetUrlCacheEntryInfoExW(lpszUrl, lpCacheEntryInfo, lpcbCacheEntryInfo, lpszRedirectUrl, lpcbRedirectUrl, lpReserved, dwFlags)

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

出力引数:

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