Share via

FindFirstUrlCacheEntryEx

  • Article

This function begins a filtered enumeration of the Internet cache.

HANDLE FindFirstUrlCacheEntryEx( 
  LPCWSTR lpszUrlSearchPattern,
  DWORD dwFlags, 
  DWORD dwFilter, 
  GROUPID GroupId, 
  LPINTERNET_CACHE_ENTRY_INFO lpFirstCacheEntryInfo,
  LPDWORD lpdwFirstCacheEntryInfoBufferSize,
  LPVOID lpGroupAttributes, 
  LPDWORD pcbGroupAttributes, 
  LPVOID lpReserved
);

Parameters

  • lpszUrlSearchPattern
    [in] Address of a string that contains the source name pattern to search for. This can be set to "cookie:" or "visited:" to enumerate the cookies and Uniform Resource Locator (URL) History entries in the cache. If this parameter is NULL, the function uses *.*.
  • dwFlags
    [in] Unsigned long integer value containing the flags controlling the enumeration. No flags are currently implemented. Must be set to zero.
  • dwFilter
    [in] Unsigned long integer value that indicates the cache entry types accepted. The following table shows the cache entry types. This parameter can be any combination of these values.
    Value Description
    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
    [in] GROUPID value indicating the cache group to enumerate. Set the value to zero to enumerate all entries not grouped.
  • lpFirstCacheEntryInfo
    [out] Address of an INTERNET_CACHE_ENTRY_INFO structure.
  • lpdwFirstCacheEntryInfoBufferSize
    [in, out] Address of an unsigned long integer variable that specifies the lpFirstCacheEntryInfo buffer size, in bytes. When the function returns, the variable contains the number of bytes copied to the buffer, or the required buffer size.
  • lpGroupAttributes
    [out] Reserved. Must be set to NULL.
  • pcbGroupAttributes
    [in, out] Reserved. Must be set to NULL.
  • lpReserved
    [in] Reserved. Must be set to NULL.

Return Values

Returns a valid handle if successful, or NULL otherwise.

Remarks

At the end of the enumeration, the application should call FindCloseUrlCache to close the handle.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Wininet.h.
Link Library: Wininet.lib.

See Also

FindCloseUrlCache | FindNextUrlCacheEntry | INTERNET_CACHE_ENTRY_INFO | WinInet Functions

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.