ホーム › Networking.HttpServer › HttpFlushResponseCache

HttpFlushResponseCache

関数

応答キャッシュ内のキャッシュ項目を破棄する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// HTTPAPI.dll
#include <windows.h>

DWORD HttpFlushResponseCache(
    HANDLE RequestQueueHandle,
    LPCWSTR UrlPrefix,
    DWORD Flags,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向	説明
RequestQueueHandle	HANDLE	in	このキャッシュが関連付けられているリクエストキューへのハンドル。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。 Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。
UrlPrefix	LPCWSTR	in	フラグメント名のサイト部分と照合する UrlPrefix 文字列へのポインター。アプリケーションは事前に HttpAddUrl を呼び出してこの UrlPrefix またはその有効なプレフィックスを対象のリクエストキューに追加し、続いて HttpAddFragmentToCache を呼び出して関連する応答フラグメントをキャッシュしておく必要があります。
Flags	DWORD	in	このパラメーターには次のフラグを指定できます。 HTTP_FLUSH_RESPONSE_FLAG_RECURSIVE サイト部分が指定された UrlPrefix に直接一致するフラグメントに加えて、サイト部分が指定された UrlPrefix の階層的な子孫である名前を持つ応答フラグメントもフラグメントキャッシュから削除します。
Overlapped	OVERLAPPED*	inoutoptional	非同期呼び出しの場合は、pOverlapped が OVERLAPPED 構造体を指すように設定します。同期呼び出しの場合は NULL に設定します。同期呼び出しはキャッシュ操作が完了するまでブロックしますが、非同期呼び出しは直ちに ERROR_IO_PENDING を返し、呼び出し元のアプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作の完了を判断します。同期のために OVERLAPPED 構造体を使用する方法の詳細については、Synchronization and Overlapped Input and Output を参照してください。

戻り値の型: DWORD

公式ドキュメント

指定された UrlPrefix にサイト部分が一致する名前を持つすべての応答フラグメントを、特定のリクエストキューに関連付けられた HTTP Server API キャッシュから削除します。

戻り値

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

関数を非同期に使用した場合、ERROR_IO_PENDING という戻り値は、キャッシュリクエストがキューに登録され、通常のオーバーラップ I/O 完了メカニズムを通じて後で完了することを示します。

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// HTTPAPI.dll
#include <windows.h>

DWORD HttpFlushResponseCache(
    HANDLE RequestQueueHandle,
    LPCWSTR UrlPrefix,
    DWORD Flags,
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpFlushResponseCache(
    IntPtr RequestQueueHandle,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string UrlPrefix,   // LPCWSTR
    uint Flags,   // DWORD
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpFlushResponseCache(
    RequestQueueHandle As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> UrlPrefix As String,   ' LPCWSTR
    Flags As UInteger,   ' DWORD
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As UInteger
End Function

' RequestQueueHandle : HANDLE
' UrlPrefix : LPCWSTR
' Flags : DWORD
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpFlushResponseCache Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal UrlPrefix As LongPtr, _
    ByVal Flags As Long, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpFlushResponseCache = ctypes.windll.httpapi.HttpFlushResponseCache
HttpFlushResponseCache.restype = wintypes.DWORD
HttpFlushResponseCache.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    wintypes.LPCWSTR,  # UrlPrefix : LPCWSTR
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpFlushResponseCache = Fiddle::Function.new(
  lib['HttpFlushResponseCache'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # UrlPrefix : LPCWSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpFlushResponseCache(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        UrlPrefix: *const u16,  // LPCWSTR
        Flags: u32,  // DWORD
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpFlushResponseCache(IntPtr RequestQueueHandle, [MarshalAs(UnmanagedType.LPWStr)] string UrlPrefix, uint Flags, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpFlushResponseCache' -Namespace Win32 -PassThru
# $api::HttpFlushResponseCache(RequestQueueHandle, UrlPrefix, Flags, Overlapped)

#uselib "HTTPAPI.dll"
#func global HttpFlushResponseCache "HttpFlushResponseCache" sptr, sptr, sptr, sptr
; HttpFlushResponseCache RequestQueueHandle, UrlPrefix, Flags, varptr(Overlapped)   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; UrlPrefix : LPCWSTR -> "sptr"
; Flags : DWORD -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpFlushResponseCache "HttpFlushResponseCache" sptr, wstr, int, var
; res = HttpFlushResponseCache(RequestQueueHandle, UrlPrefix, Flags, Overlapped)
; RequestQueueHandle : HANDLE -> "sptr"
; UrlPrefix : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "HTTPAPI.dll"
#cfunc global HttpFlushResponseCache "HttpFlushResponseCache" sptr, wstr, int, sptr
; res = HttpFlushResponseCache(RequestQueueHandle, UrlPrefix, Flags, varptr(Overlapped))
; RequestQueueHandle : HANDLE -> "sptr"
; UrlPrefix : LPCWSTR -> "wstr"
; Flags : DWORD -> "int"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。