RetrieveUrlCacheEntryFileW

指定した URL に関連付けられたキャッシュエントリファイルをロックする。(Unicode)

RetrieveUrlCacheEntryFileW lpszUrlName, lpCacheEntryInfo, lpcbCacheEntryInfo, dwReserved

lpszUrlName : [wstr] キャッシュエントリに関連付けられたリソースの URL を格納した文字列へのポインタ。これは一意な名前でなければならない。名前文字列にエスケープ文字を含めてはならない。
lpCacheEntryInfo : [var] キャッシュエントリ情報バッファへのポインタ。バッファが十分でない場合、本関数は ERROR_INSUFFICIENT_BUFFER を返し、lpdwCacheEntryInfoBufferSize に必要なバイト数を設定する。
lpcbCacheEntryInfo : [var] lpCacheEntryInfo バッファのサイズ (バイト単位) を指定する unsigned long 整数変数へのポインタ。関数が戻ると、変数には実際に使用されたバッファのサイズ (バイト単位)、またはキャッシュエントリファイルの取得に必要なバイト数が格納される。呼び出し側は本パラメータの戻り値をチェックすべきである。戻りサイズが渡されたサイズ以下であれば、関連するすべてのデータが返されている。
dwReserved : [int] 本パラメータは予約されており、0 を指定しなければならない。

(プラグイン / モジュール : wininet.dll)

解説

指定した URL に関連付けられたキャッシュエントリファイルをロックする。(Unicode)

[戻り値]
成功した場合は TRUE を、失敗した場合は FALSE を返す。拡張エラー情報を取得するには GetLastError
を呼び出す。想定されるエラー値には次のものがある。
（以下省略）

[備考]
RetrieveUrlCacheEntryFile は URL の解析を一切行わないため、アンカー (#) を含む URL
は、リソースがキャッシュされていてもキャッシュ内で見つからない。例えば
http://adatum.com/example.htm#sample
を渡した場合、http://adatum.com/example.htm がキャッシュにあっても関数は
ERROR_FILE_NOT_FOUND
を返す。ファイルは取得時に呼び出し側のためにロックされる。呼び出し側はファイルの使用が終わったらロックを解除すべきである。キャッシュマネージャは一定間隔の後にファイルのロックを自動的に解除する。ファイルがロックされている間、キャッシュマネージャはキャッシュからファイルを削除しない。本関数はキャッシュの内部実装に応じて効率的に動作する場合とそうでない場合があることに注意することが重要である。例えば、URL
データが他の URL
のデータも含むパックファイルに格納されている場合、キャッシュはキャッシュが管理する一時ディレクトリ内のファイルにデータをコピーする。コピーは最終的にキャッシュによって削除される。本関数はアプリケーションを起動するためにファイル名が必要な状況でのみ使用することを推奨する。ほとんどの場合、RetrieveUrlCacheEntryStream
および関連するストリーム関数を使用すべきである。WinINet API の他のすべての側面と同様に、本関数は DllMain
やグローバルオブジェクトのコンストラクタ・デストラクタの中から安全に呼び出すことはできない。注意: WinINet
はサーバー実装をサポートしていない。さらに、サービスから使用すべきでもない。サーバー実装やサービスでは Microsoft Windows
HTTP Services (WinHTTP) を使用すること。
> [!NOTE] > wininet.h ヘッダーは RetrieveUrlCacheEntryFile
をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて本関数の ANSI 版または Unicode
版を自動的に選択する。エンコーディング中立のエイリアスとエンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーの原因となるミスマッチが発生する可能性がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照のこと。

情報