FindFirstUrlCacheEntryA 関数 (wininet.h)

  • [アーティクル]

インターネット キャッシュの列挙を開始します。

構文

HANDLE FindFirstUrlCacheEntryA(
  [in]      LPCSTR                       lpszUrlSearchPattern,
  [out]     LPINTERNET_CACHE_ENTRY_INFOA lpFirstCacheEntryInfo,
  [in, out] LPDWORD                      lpcbCacheEntryInfo
);

パラメーター

[in] lpszUrlSearchPattern

検索するソース名パターンを含む文字列へのポインター。 このパラメーターは、"cookie:"、"visited:"、または NULL にのみ設定できます。 Cookie を列挙するにはこのパラメーターを "cookie:" に設定し、キャッシュ内の URL 履歴エントリを列挙する場合は "visited:" に設定します。 このパラメーターが NULL の場合、 FindFirstUrlCacheEntry はキャッシュ内のすべてのコンテンツ エントリを返します。

[out] lpFirstCacheEntryInfo

INTERNET_CACHE_ENTRY_INFO構造体へのポインター。

[in, out] lpcbCacheEntryInfo

lpFirstCacheEntryInfo バッファーのサイズをバイト単位で指定する変数へのポインター。 関数が戻るとき、変数にはバッファーにコピーされたバイト数、またはキャッシュ エントリを取得するために必要なサイズ (バイト単位) が含まれます。

戻り値

FindNextUrlCacheEntry 関数でアプリケーションがキャッシュ内の後続のエントリを取得するために使用できるハンドルを返します。 関数が失敗した場合は、返される値は NULL です。 詳細なエラー情報を得るには、GetLastError を呼び出します。

ERROR_INSUFFICIENT_BUFFERは、 lpdwFirstCacheEntryInfoBufferSize で指定された lpFirstCacheEntryInfo のサイズが、すべての情報を格納するのに十分ではないことを示します。 lpdwFirstCacheEntryInfoBufferSize で返される値は、すべての情報を格納するために必要なバッファー サイズを示します。

解説

FindFirstUrlCacheEntry から返されるハンドルは、FindNextUrlCacheEntry への後続のすべての呼び出しで使用されます。 列挙の最後に、アプリケーションは FindCloseUrlCache を呼び出す必要があります。

FindFirstUrlCacheEntry と FindNextUrlCacheEntry は、変数サイズ情報を返します。 ERROR_INSUFFICIENT_BUFFERが返された場合、アプリケーションは lpdwFirstCacheEntryInfoBufferSize で指定されたサイズのバッファーを割り当てる必要があります。 詳細については、「バッファーの 使用」を参照してください。

WinINet API の他のすべての側面と同様に、この関数を DllMain またはグローバル オブジェクトのコンストラクターとデストラクター内から安全に呼び出すことはできません。

メモ WinINet では、サーバーの実装はサポートされていません。 また、サービスから使用しないでください。 サーバーの実装またはサービスの場合は、 Microsoft Windows HTTP サービス (WinHTTP) を使用します。
 

注意

wininet.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして FindFirstUrlCacheEntry を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー wininet.h
Library Wininet.lib
[DLL] Wininet.dll

関連項目

キャッシュ

WinINet 関数