ホーム › Networking.WinInet › FindFirstUrlCacheEntryA

FindFirstUrlCacheEntryA

関数

URLキャッシュエントリの列挙を開始し最初の項目を取得する(ANSI版)。

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

シグネチャ

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

HANDLE FindFirstUrlCacheEntryA(
    LPCSTR lpszUrlSearchPattern,   // optional
    INTERNET_CACHE_ENTRY_INFOA* lpFirstCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo
);

パラメーター

名前	型	方向	説明
lpszUrlSearchPattern	LPCSTR	inoptional	検索するソース名のパターンを格納した文字列へのポインター。このパラメーターには "cookie:"、"visited:"、または NULL のいずれかのみを設定できます。Cookie を列挙するにはこのパラメーターに "cookie:" を設定し、キャッシュ内の URL 履歴エントリを列挙するには "visited:" を設定します。このパラメーターが NULL の場合、FindFirstUrlCacheEntry はキャッシュ内のすべてのコンテンツエントリを返します。
lpFirstCacheEntryInfo	INTERNET_CACHE_ENTRY_INFOA*	inoutoptional	INTERNET_CACHE_ENTRY_INFO 構造体へのポインター。
lpcbCacheEntryInfo	DWORD*	inout	lpFirstCacheEntryInfo バッファーのサイズをバイト単位で指定する変数へのポインター。関数が戻ると、この変数にはバッファーにコピーされたバイト数、またはキャッシュエントリの取得に必要なサイズがバイト単位で格納されます。

戻り値の型: HANDLE

公式ドキュメント

インターネットキャッシュの列挙を開始します。(ANSI)

戻り値

アプリケーションが FindNextUrlCacheEntry 関数でキャッシュ内の後続エントリを取得するために使用できるハンドルを返します。関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

ERROR_INSUFFICIENT_BUFFER は、 lpdwFirstCacheEntryInfoBufferSize で指定された lpFirstCacheEntryInfo のサイズがすべての情報を格納するには不十分であることを示します。 lpdwFirstCacheEntryInfoBufferSize に返される値は、すべての情報を格納するために必要なバッファーサイズを示します。

解説(Remarks)

FindFirstUrlCacheEntry から返されるハンドルは、FindNextUrlCacheEntry への以降のすべての呼び出しで使用されます。列挙の終了時には、アプリケーションは FindCloseUrlCache を呼び出す必要があります。

FindFirstUrlCacheEntry と FindNextUrlCacheEntry は可変サイズの情報を返します。ERROR_INSUFFICIENT_BUFFER が返された場合、アプリケーションは lpdwFirstCacheEntryInfoBufferSize で指定されたサイズのバッファーを割り当てる必要があります。詳細については、 Using Buffers を参照してください。

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

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

メモ

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

HANDLE FindFirstUrlCacheEntryA(
    LPCSTR lpszUrlSearchPattern,   // optional
    INTERNET_CACHE_ENTRY_INFOA* lpFirstCacheEntryInfo,   // optional
    DWORD* lpcbCacheEntryInfo
);

[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstUrlCacheEntryA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrlSearchPattern,   // LPCSTR optional
    IntPtr lpFirstCacheEntryInfo,   // INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    ref uint lpcbCacheEntryInfo   // DWORD* in/out
);

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FindFirstUrlCacheEntryA = Fiddle::Function.new(
  lib['FindFirstUrlCacheEntryA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrlSearchPattern : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFirstCacheEntryInfo : INTERNET_CACHE_ENTRY_INFOA* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpcbCacheEntryInfo : DWORD* in/out
  ],
  Fiddle::TYPE_VOIDP)

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

$sig = @"
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr FindFirstUrlCacheEntryA([MarshalAs(UnmanagedType.LPStr)] string lpszUrlSearchPattern, IntPtr lpFirstCacheEntryInfo, ref uint lpcbCacheEntryInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FindFirstUrlCacheEntryA' -Namespace Win32 -PassThru
# $api::FindFirstUrlCacheEntryA(lpszUrlSearchPattern, lpFirstCacheEntryInfo, lpcbCacheEntryInfo)

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

出力引数:

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