FindFirstUrlCacheGroup function (wininet.h)

Article
02/22/2024

Initiates the enumeration of the cache groups in the Internet cache.

Syntax

HANDLE FindFirstUrlCacheGroup(
  [in]      DWORD   dwFlags,
  [in]      DWORD   dwFilter,
  [in]      LPVOID  lpSearchCondition,
  [in]      DWORD   dwSearchCondition,
  [out]     GROUPID *lpGroupId,
  [in, out] LPVOID  lpReserved
);

Parameters

[in] dwFlags

This parameter is reserved and must be 0.

[in] dwFilter

Filters to be used. This parameter can be zero or one of the following values.

Value	Meaning
CACHEGROUP_SEARCH_ALL	Search all cache groups.
CACHEGROUP_SEARCH_BYURL	Not currently implemented.

[in] lpSearchCondition

This parameter is reserved and must be NULL.

[in] dwSearchCondition

This parameter is reserved and must be 0.

[out] lpGroupId

Pointer to the ID of the first cache group that matches the search criteria.

[in, out] lpReserved

This parameter is reserved and must be NULL.

Return value

Returns a valid handle to the first item in the enumeration if successful, or NULL otherwise. To get specific error information, call GetLastError. If the function finds no matching files, GetLastError returns ERROR_NO_MORE_FILES.

Remarks

The handle returned from FindFirstUrlCacheGroup is used in subsequent calls to FindNextUrlCacheGroup. At the end of the enumeration, the application should call FindCloseUrlCache.

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

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wininet.h
Library	Wininet.lib
DLL	Wininet.dll