FindFirstUrlCacheEntry

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function begins the enumeration of the Internet cache.

Syntax

HANDLE FindFirstUrlCacheEntry( 
  LPCTSTR lpszUrlSearchPattern,
  LPINTERNET_CACHE_ENTRY_INFO lpFirstCacheEntryInfo,
  LPDWORD lpdwFirstCacheEntryInfoBufferSize
);

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 *.*.
  • 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.

Return Value

If successful, this function returns a handle that the application can use in the FindNextUrlCacheEntry function to retrieve subsequent cache entries. If the function fails, the return value is NULL.

ERROR_INSUFFICIENT_BUFFER indicates that the size of lpFirstCacheEntryInfo as specified by lpdwFirstCacheEntryInfoBufferSize is not sufficient to contain all the data. The value returned in lpdwFirstCacheEntryInfoBufferSize indicates the buffer size necessary to contain all the data.

Remarks

This function and FindNextUrlCacheEntry return variable size data. If ERROR_INSUFFICIENT_BUFFER is returned, the application should allocate a buffer of the size specified by lpdwFirstCacheEntryInfoBufferSize. When the enumeration is complete, call FindCloseUrlCache to close the handle.

Requirements

Library wininet.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

FindNextUrlCacheEntry
INTERNET_CACHE_ENTRY_INFO
WinInet Functions