ホーム › Networking.WinInet › GetUrlCacheEntryInfoExA

GetUrlCacheEntryInfoExA

関数

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

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

シグネチャ

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

BOOL GetUrlCacheEntryInfoExA(
    LPCSTR lpszUrl,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,   // optional
    LPSTR lpszRedirectUrl,   // optional
    DWORD* lpcbRedirectUrl,   // optional
    void* lpReserved,   // optional
    DWORD dwFlags
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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 を定義しています。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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>

BOOL GetUrlCacheEntryInfoExA(
    LPCSTR lpszUrl,
    INTERNET_CACHE_ENTRY_INFOA* lpCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo,   // optional
    LPSTR lpszRedirectUrl,   // optional
    DWORD* lpcbRedirectUrl,   // optional
    void* lpReserved,   // optional
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetUrlCacheEntryInfoExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrl,   // LPCSTR
    IntPtr lpCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    IntPtr lpcbCacheEntryInfo,   // DWORD* optional, in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszRedirectUrl,   // LPSTR optional
    IntPtr lpcbRedirectUrl,   // DWORD* optional
    IntPtr lpReserved,   // void* optional
    uint dwFlags   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUrlCacheEntryInfoExA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As String,   ' LPCSTR
    lpCacheEntryInfo As IntPtr,   ' INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    lpcbCacheEntryInfo As IntPtr,   ' DWORD* optional, in/out
    <MarshalAs(UnmanagedType.LPStr)> lpszRedirectUrl As System.Text.StringBuilder,   ' LPSTR optional
    lpcbRedirectUrl As IntPtr,   ' DWORD* optional
    lpReserved As IntPtr,   ' void* optional
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

GetUrlCacheEntryInfoExA = ctypes.windll.wininet.GetUrlCacheEntryInfoExA
GetUrlCacheEntryInfoExA.restype = wintypes.BOOL
GetUrlCacheEntryInfoExA.argtypes = [
    wintypes.LPCSTR,  # lpszUrl : LPCSTR
    ctypes.c_void_p,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # lpcbCacheEntryInfo : DWORD* optional, in/out
    wintypes.LPSTR,  # lpszRedirectUrl : LPSTR 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')
GetUrlCacheEntryInfoExA = Fiddle::Function.new(
  lib['GetUrlCacheEntryInfoExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheEntryInfo : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpszRedirectUrl : LPSTR optional
    Fiddle::TYPE_VOIDP,  # lpcbRedirectUrl : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpReserved : void* optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn GetUrlCacheEntryInfoExA(
        lpszUrl: *const u8,  // LPCSTR
        lpCacheEntryInfo: *mut INTERNET_CACHE_ENTRY_INFOA,  // INTERNET_CACHE_ENTRY_INFOA* optional, in/out
        lpcbCacheEntryInfo: *mut u32,  // DWORD* optional, in/out
        lpszRedirectUrl: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool GetUrlCacheEntryInfoExA([MarshalAs(UnmanagedType.LPStr)] string lpszUrl, IntPtr lpCacheEntryInfo, IntPtr lpcbCacheEntryInfo, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszRedirectUrl, IntPtr lpcbRedirectUrl, IntPtr lpReserved, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_GetUrlCacheEntryInfoExA' -Namespace Win32 -PassThru
# $api::GetUrlCacheEntryInfoExA(lpszUrl, lpCacheEntryInfo, lpcbCacheEntryInfo, lpszRedirectUrl, lpcbRedirectUrl, lpReserved, dwFlags)

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

出力引数:

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