Retrieves information on the cache entry associated with the specified URL, taking into account any redirections that are applied in offline mode by the
HttpSendRequest function.
Syntax
BOOLAPI GetUrlCacheEntryInfoEx(
__in LPCTSTR lpszUrl,
__inout_opt LPINTERNET_CACHE_ENTRY_INFO lpCacheEntryInfo,
__inout_opt LPDWORD lpcbCacheEntryInfo,
__reserved LPTSTR lpszRedirectUrl,
__reserved LPDWORD lpcbRedirectUrl,
__reserved LPVOID lpReserved,
__in DWORD dwFlags
);
Parameters
- lpszUrl [in]
-
Pointer to a null-terminated string that contains the name of the cache entry. The name string should not contain any escape characters.
- lpCacheEntryInfo [in, out, optional]
-
Pointer to an
INTERNET_CACHE_ENTRY_INFO structure that receives information about the cache entry.
- lpcbCacheEntryInfo [in, out, optional]
-
Pointer to a variable that specifies the size of the
lpCacheEntryInfo buffer, in bytes. When the function returns, the variable contains the number of bytes copied to the buffer, or the required size of the buffer in bytes.
- lpszRedirectUrl [out]
-
This parameter is reserved and must be NULL.
- lpcbRedirectUrl [in, out]
-
This parameter is reserved and must be NULL.
- lpReserved
-
This parameter is reserved and must be NULL.
- dwFlags [in]
-
This parameter is reserved and must be 0.
Return Value
Returns TRUE if the URL was located, or FALSE otherwise. Call
GetLastError for specific error information. Possible errors include the following.
| Return code | Description |
- ERROR_FILE_NOT_FOUND
| The URL was not found in the cache index, even after taking any cached redirections into account.
|
- ERROR_INSUFFICIENT_BUFFER
| The buffer referenced by
lpCacheEntryInfo was not large enough to hold the requested information. The size of the buffer needed will be returned to
lpdwCacheEntryInfoBufSize.
|
Remarks
GetUrlCacheEntryInfo 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://example.com/example.htm#sample is passed, the function returns ERROR_FILE_NOT_FOUND even if http://example.com/example.htm is in the cache.
Requirements
| Minimum supported client | Windows 2000 Professional |
| Minimum supported server | Windows 2000 Server |
| Version | Internet Explorer 4.0 or later |
| Header | Wininet.h |
| Library | Wininet.lib |
| DLL | Wininet.dll |
| Unicode and ANSI names | GetUrlCacheEntryInfoExW (Unicode) and GetUrlCacheEntryInfoExA (ANSI) |
See Also
- Caching
- WinINet Functions
Send comments about this topic to Microsoft
Build date: 11/19/2009