CreateUrlCacheEntryW 関数 (wininet.h)

  • [アーティクル]

指定した URL とファイル名拡張子に基づいて、キャッシュ エントリを保存するためのローカル ファイル名を作成します。

構文

BOOL CreateUrlCacheEntryW(
  [in]  LPCWSTR lpszUrlName,
  [in]  DWORD   dwExpectedFileSize,
  [in]  LPCWSTR lpszFileExtension,
  [out] LPWSTR  lpszFileName,
  [in]  DWORD   dwReserved
);

パラメーター

[in] lpszUrlName

URL の名前を含む文字列値へのポインター。 文字列には値が含まれている必要があります。空の文字列を指定すると、 CreateUrlCacheEntry が失敗します。 また、文字列にはエスケープ文字を含めてはなりません。

[in] dwExpectedFileSize

ソース エンティティに対応するデータを TCHAR に格納するために必要なファイルの予想サイズ。 予想されるサイズが不明な場合は、この値を 0 に設定します。

[in] lpszFileExtension

ローカル ストレージ内のファイルの拡張子名を含む文字列値へのポインター。

[out] lpszFileName

ファイル名を受け取るバッファーへのポインター。 バッファーは、作成されたファイルのパスを格納するのに十分な大きさにする必要があります (少なくともMAX_PATH文字の長さ)。

[in] dwReserved

このパラメーターは予約済みであり、0 である必要があります。

戻り値

関数が成功した場合、関数は TRUE を返します。

関数が失敗すると、 FALSE が返されます。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

CreateUrlCacheEntry が呼び出されると、アプリケーションはローカル ストレージ内のファイルに直接書き込むことができます。 ファイルが完全に受信されると、呼び出し元は CommitUrlCacheEntry を呼び出してキャッシュ内のエントリをコミットする必要があります。

WinINet は、システム コード ページに従って Unicode パラメーターのデコードを試みます。 アプリケーションでは、Unicode パラメーターがシステム コード ページに対して適切にエンコードされていることを確認する必要があります。 アプリケーションは、次のコード例に示すように 、InternetSetOption を使用してシステム コード ページを設定できます。

DWORD CP_SHIFT_JIS = 932;  // ANSI/OEM  Japanese, Shift-JIS
InternetSetOption( hRequest, 
                   INTERNET_OPTION_CODEPAGE,
                   &CP_SHIFT_JIS, 
                   sizeof(DWORD) );

Unicode パラメーターがシステム コード ページに正しくエンコードされていない場合、WinINet は UTF8 デコードを試みます。

キャッシュから項目を取得する場合、キャッシュに項目を配置するために使用されたシステム コード ページは、ユーザーの現在のシステム コード ページと一致している必要があります。 IE6 以前で実行されているアプリケーションの場合、システム コード ページのデコードに失敗した場合、WinINet は UTF8 デコードを試みます。

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

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

注意

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

要件

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

こちらもご覧ください

キャッシュ

CommitUrlCacheEntry

WinINet 関数