FindFirstUrlCacheEntryEx Function

---

Starts a filtered enumeration of the Internet cache.

Syntax

HANDLE FindFirstUrlCacheEntryEx(
    IN LPCSTR lpszUrlSearchPattern,
    IN DWORD dwFlags,
    IN DWORD dwFilter,
    IN GROUPID GroupId
    OUT LPINTERNET_CACHE_ENTRY_INFO  lpFirstCacheEntryInfo,
    IN OUT LPDWORD lpdwFirstCacheEntryInfoBufferSize,
    OUT LPVOID lpReserved,
    IN OUT LPDWORD pcbReserved2,
    IN LPVOID lpReserved3
);

The actual syntax of this function varies between its ANSI and Unicode implementations. For more information, see Win32 Internet Functions Syntax.

Parameters

lpszUrlSearchPattern

String that contains the search pattern. Search patterns are currently not supported, so the value must be set to NULL to indicate all entries with the matching GROUPID.

dwFlags

Unsigned long integer value that contains the flags controlling the enumeration. No flags are currently implemented; this must be set to zero.

dwFilter

Unsigned long integer value that indicates the cache entry types that are allowed. This can be any combination of cache entry types:

COOKIE_CACHE_ENTRY

Cookie cache entry.

NORMAL_CACHE_ENTRY

Normal cache entry; can be deleted to recover space for new entries.

STICKY_CACHE_ENTRY

Sticky cache entry; exempt from scavenging.

TRACK_OFFLINE_CACHE_ENTRY

Not currently implemented.

TRACK_ONLINE_CACHE_ENTRY

Not currently implemented.

URLHISTORY_CACHE_ENTRY

Visited link cache entry.

GroupId

GROUPID value that indicates the cache group to enumerate. Set the value to zero to enumerate all entries that are not grouped.

lpFirstCacheEntryInfo

Address of the buffer to hold the INTERNET_CACHE_ENTRY_INFO structure in which the cache entry information will be stored.

lpdwFirstCacheEntryInfoBufferSize

Address of an unsigned long integer variable that indicates the size of lpFirstCacheEntryInfo, in TCHARs.

lpReserved

Reserved. Must be set to NULL.

pcbReserved2

Reserved. Must be set to NULL.

lpReserved3

Reserved. Must be set to NULL.

Return Value

Returns a valid handle if successful, or NULL otherwise. To get specific error information, call GetLastError. If the function finds no matching files, GetLastError returns ERROR_NO_MORE_FILES.

Remarks

At the end of the enumeration, the application should call FindCloseUrlCache.

Function Information

Windows NT	Use version 4.0. Implemented as ANSI and Unicode functions.
Windows	Use Windows 95 and later. Implemented as ANSI and Unicode functions.
Header	Wininet.h
Import library	Wininet.lib
Minimum availability	Internet Explorer 4.0 (ANSI only), 5 (ANSI and Unicode)

Windows CE

Windows CE	Use version 2.12 and later. Implemented as ANSI and Unicode functions.
Minimum availability	Internet Explorer 4.0

See Also

Microsoft Win32 Internet Functions Overview, Caching, Microsoft Win32 Internet Functions Reference, Persistent URL Cache Functions