Provides the most efficient and implementation-independent way to access the cache data.

Syntax

HANDLE RetrieveUrlCacheEntryStream(
  __in     LPCTSTR lpszUrlName,
  __out    LPINTERNET_CACHE_ENTRY_INFO lpCacheEntryInfo,
  __inout  LPDWORD lpcbCacheEntryInfo,
  __in     BOOL fRandomRead,
  __in     DWORD dwReserved
);

Parameters

lpszUrlName [in]

Pointer to a null-terminated string that contains the source name of the cache entry. This must be a unique name. The name string should not contain any escape characters.

lpCacheEntryInfo [out]

Pointer to an INTERNET_CACHE_ENTRY_INFO structure that receives information about the cache entry.

lpcbCacheEntryInfo [in, out]

Pointer to a variable that specifies the size, in bytes, of the lpCacheEntryInfo buffer. When the function returns, the variable receives the number of bytes copied to the buffer or the required size, in bytes, of the buffer. Note that this buffer size must accommodate both the INTERNET_CACHE_ENTRY_INFO structure and the associated strings that are stored immediately following it.

fRandomRead [in]

Whether the stream is open for random access. Set the flag to TRUE to open the stream for random access.

dwReserved [in]

This parameter is reserved and must be 0.

Return Value

If the function succeeds, the function returns a valid handle for use in the ReadUrlCacheEntryStream and UnlockUrlCacheEntryStream functions.

If the function fails, it returns NULL. To get extended error information, call GetLastError.

Possible error values include the following.

Remarks

RetrieveUrlCacheEntryStream does not do any URL parsing, so a URL containing an anchor (#) will not be found in the cache, even if the resource is cached. For example, if the URL http://adatum.com/example.htm#sample is passed, the function returns ERROR_FILE_NOT_FOUND even if http://adatum.com/example.htm is in the cache.

Cache clients that do not need URL data in the form of a file should use this function to access the data for a particular URL.

Requirements

See Also

Caching

WinINet Functions

Send comments about this topic to Microsoft

Build date: 11/19/2009