HttpFlushResponseCache 関数 (http.h)

  • [アーティクル]

HttpFlushResponseCache 関数は、指定された要求キューに関連付けられている HTTP Server API キャッシュから、サイト部分が指定された UrlPrefix と一致する名前を持つすべての応答フラグメントを削除します。 この UrlPrefix またはその有効なプレフィックスを対象の要求キューに追加するには、アプリケーションで HttpAddUrl または HttpAddUrlToUrlGroup を呼び出し、関連付けられた応答フラグメントまたはフラグメントをキャッシュするために HttpAddFragmentToCache を呼び出しておく必要があります。

構文

HTTPAPI_LINKAGE ULONG HttpFlushResponseCache(
  [in] HANDLE       RequestQueueHandle,
  [in] PCWSTR       UrlPrefix,
  [in] ULONG        Flags,
  [in] LPOVERLAPPED Overlapped
);

パラメーター

[in] RequestQueueHandle

このキャッシュが関連付けられている要求キューを処理します。 要求キューが作成され、そのハンドルが HttpCreateRequestQueue 関数の呼び出しによって返されます。

Windows Server 2003 SP1 と Windows XP SP2: 要求キューへのハンドルは、 HttpCreateHttpHandle 関数によって作成されます。

[in] UrlPrefix

フラグメント名のサイト部分と照合する UrlPrefix 文字列 へのポインター。 この UrlPrefix またはその有効なプレフィックスを対象の要求キューに追加するには、アプリケーションで HttpAddUrl を呼び出し、関連する応答フラグメントをキャッシュするために HttpAddFragmentToCache を呼び出す必要があります。

[in] Flags

このパラメーターには、次のフラグを含めることができます。

HTTP_FLUSH_RESPONSE_FLAG_RECURSIVE

サイト部分が指定された UrlPrefix の階層子孫である名前を持つ応答フラグメントを、直接一致するサイト部分を持つフラグメントに加えて、フラグメント キャッシュから削除します。

[in] Overlapped

非同期呼び出しの場合 は、pOverlapped を OVERLAPPED 構造体をポイントするように設定するか、同期呼び出しの場合は NULL に設定 します。

同期呼び出しはキャッシュ操作が完了するまでブロックしますが、非同期呼び出しはすぐにERROR_IO_PENDINGを返し、呼び出し元のアプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作がいつ完了するかを判断します。 同期に OVERLAPPED 構造体を使用する方法の詳細については、「 同期」と「重複した入力と出力」を参照してください。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が非同期的に使用される場合、戻り値ERROR_IO_PENDINGは、キャッシュ要求がキューに入れられ、通常の重複した I/O 完了メカニズムによって後で完了することを示します。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

値 説明
ERROR_INVALID_PARAMETER
 いずれかのパラメーターが無効です。
その他
 WinError.h で定義されている システム エラー コード 。

要件

   
サポートされている最小のクライアント Windows Vista、SP2 を使用した Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー http.h
Library Httpapi.lib
[DLL] Httpapi.dll

関連項目

HTTP Server API バージョン 1.0 関数

HttpAddFragmentToCache

HttpReadFragmentFromCache