GetUrlCacheEntryInfoA 関数 (wininet.h)

  • [アーティクル]

キャッシュ エントリに関する情報を取得します。

構文

BOOL GetUrlCacheEntryInfoA(
  [in]      LPCSTR                       lpszUrlName,
  [out]     LPINTERNET_CACHE_ENTRY_INFOA lpCacheEntryInfo,
  [in, out] LPDWORD                      lpcbCacheEntryInfo
);

パラメーター

[in] lpszUrlName

キャッシュ エントリの名前を含む null で終わる文字列へのポインター。 名前文字列にはエスケープ文字を含めないようにしてください。

[out] lpCacheEntryInfo

キャッシュ エントリに関する情報を受け取る INTERNET_CACHE_ENTRY_INFO 構造体へのポインター。 このパラメーターにはバッファーを割り当てる必要があります。

バッファーの必要なサイズは事前にわかっていないので、ほとんどの INTERNET_CACHE_ENTRY_INFO エントリのサイズを処理するのに十分なバッファーを割り当てるのが最善です。 キャッシュ エントリのサイズ制限がないため、キャッシュを列挙する必要があるアプリケーションは、可変サイズのバッファーを割り当てる準備をする必要があります。

[in, out] lpcbCacheEntryInfo

lpCacheEntryInfo バッファーのサイズをバイト単位で指定する変数へのポインター。 関数が戻るとき、変数にはバッファーにコピーされたバイト数、またはバッファーの必要なサイズがバイト単位で格納されます。

戻り値

成功した場合は TRUE 、それ以外の場合 は FALSE を 返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。 考えられるエラー値は次のとおりです。

リターン コード 説明
ERROR_FILE_NOT_FOUND
 指定されたキャッシュ エントリがキャッシュに見つかりません。
ERROR_INSUFFICIENT_BUFFER
 lpdwCacheEntryInfoBufferSize で指定された lpCacheEntryInfo のサイズでは、すべての情報を含むには不十分です。 lpdwCacheEntryInfoBufferSize で返される値は、すべての情報を格納するために必要なバッファー サイズを示します。

解説

GetUrlCacheEntryInfo は URL 解析を行わないので、リソースがキャッシュされている場合でも、アンカー (#) を含む URL はキャッシュに見つかりません。 たとえば、URL http://example.com/example.htm#sample が渡された場合、 がキャッシュ内にある場合http://example.com/example.htmでも、関数はERROR_FILE_NOT_FOUNDを返します。

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

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

Note

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

要件

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

関連項目

キャッシュ

WinINet 関数