nf-wininet-geturlcacheentryinfoexa.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:wininet.GetUrlCacheEntryInfoExA	GetUrlCacheEntryInfoExA function (wininet.h)	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. (ANSI)	GetUrlCacheEntryInfoExA wininet/GetUrlCacheEntryInfoExA	wininet\geturlcacheentryinfoex.htm	wininet	3842dae9-9474-492a-83fa-29d7927dc92d	12/05/2018	GetUrlCacheEntryInfoEx, GetUrlCacheEntryInfoEx function [WinINet], GetUrlCacheEntryInfoExA, GetUrlCacheEntryInfoExW, _inet_geturlcacheentryinfoex_function, wininet.geturlcacheentryinfoex, wininet/GetUrlCacheEntryInfoEx, wininet/GetUrlCacheEntryInfoExA, wininet/GetUrlCacheEntryInfoExW	wininet.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]				GetUrlCacheEntryInfoExW (Unicode) and GetUrlCacheEntryInfoExA (ANSI)						Wininet.lib	Wininet.dll		Windows			19H1	GetUrlCacheEntryInfoExA wininet/GetUrlCacheEntryInfoExA	c++	APIRef kbSyntax	DllExport	Wininet.dll	GetUrlCacheEntryInfoEx GetUrlCacheEntryInfoExA GetUrlCacheEntryInfoExW

GetUrlCacheEntryInfoExA function

-description

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.

-parameters

-param lpszUrl [in]

A pointer to a null-terminated string that contains the name of the cache entry. The name string should not contain any escape characters.

-param lpCacheEntryInfo [in, out, optional]

A pointer to an INTERNET_CACHE_ENTRY_INFO structure that receives information about the cache entry. A buffer should be allocated for this parameter.

Since the required size of the buffer is not known in advance, it is best to allocate a buffer adequate to handle the size of most INTERNET_CACHE_ENTRY_INFO entries. There is no cache entry size limit, so applications that need to enumerate the cache must be prepared to allocate variable-sized buffers.

-param 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.

-param lpszRedirectUrl [out]

This parameter is reserved and must be NULL.

-param lpcbRedirectUrl [in, out]

This parameter is reserved and must be NULL.

-param lpReserved

This parameter is reserved and must be NULL.

-param dwFlags [in]

This parameter is reserved and must be 0.

-returns

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

GetUrlCacheEntryInfoEx 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.

Like all other aspects of the WinINet API, this function cannot be safely called from within DllMain or the constructors and destructors of global objects.

Note  WinINet does not support server implementations. In addition, it should not be used from a service. For server implementations or services use Microsoft Windows HTTP Services (WinHTTP).

 

Note

The wininet.h header defines GetUrlCacheEntryInfoEx as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

Caching

WinINet Functions