ホーム › Networking.HttpServer › HttpAddFragmentToCache

HttpAddFragmentToCache

関数

応答フラグメントをキャッシュに追加する。

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

シグネチャ

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

DWORD HttpAddFragmentToCache(
    HANDLE RequestQueueHandle,
    LPCWSTR UrlPrefix,
    HTTP_DATA_CHUNK* DataChunk,
    HTTP_CACHE_POLICY* CachePolicy,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向	説明
RequestQueueHandle	HANDLE	in	このキャッシュが関連付けられる要求キューへのハンドル。要求キューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。 Windows Server 2003 with SP1 および Windows XP with SP2: 要求キューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。
UrlPrefix	LPCWSTR	in	このキャッシュエントリを識別するために、アプリケーションが以後の HttpSendHttpResponse の呼び出しで使用する UrlPrefix 文字列へのポインター。アプリケーションは、ReqQueueHandle パラメーターと同じハンドルを指定し、この UrlPrefix 文字列と同一の文字列またはその有効なプレフィックスを指定して、事前に HttpAddUrl を呼び出しておく必要があります。他の UrlPrefix と同様に、この文字列は "scheme://host:port/relativeURI" の形式である必要があります。例: `http://www.mysite.com:80/image1.gif`。
DataChunk	HTTP_DATA_CHUNK*	in	pUrlPrefix が指す名前でキャッシュするエンティティ本体のデータブロックを指定する HTTP_DATA_CHUNK 構造体へのポインター。
CachePolicy	HTTP_CACHE_POLICY*	in	このデータフラグメントをどのようにキャッシュするかを指定する HTTP_CACHE_POLICY 構造体へのポインター。
Overlapped	OVERLAPPED*	inoutoptional	非同期呼び出しの場合は、pOverlapped が OVERLAPPED 構造体を指すように設定します。同期呼び出しの場合は NULL に設定します。同期呼び出しは、キャッシュ操作が完了するまで呼び出し元のスレッドをブロックします。一方、非同期呼び出しは直ちに ERROR_IO_PENDING を返し、呼び出し元のアプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作の完了時期を判断します。同期のために OVERLAPPED 構造体を使用する方法の詳細については、Synchronization and Overlapped Input and Output を参照してください。

戻り値の型: DWORD

公式ドキュメント

HttpAddFragmentToCache 関数は、後で取得できるように指定した名前でデータフラグメントをキャッシュするか、指定した名前でキャッシュされているデータを更新します。

戻り値

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

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

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

値	意味
ERROR_INVALID_PARAMETER	指定されたパラメーターの 1 つ以上が使用できない形式です。
その他	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 HttpAddFragmentToCache(
    HANDLE RequestQueueHandle,
    LPCWSTR UrlPrefix,
    HTTP_DATA_CHUNK* DataChunk,
    HTTP_CACHE_POLICY* CachePolicy,
    OVERLAPPED* Overlapped   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

HttpAddFragmentToCache = ctypes.windll.httpapi.HttpAddFragmentToCache
HttpAddFragmentToCache.restype = wintypes.DWORD
HttpAddFragmentToCache.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    wintypes.LPCWSTR,  # UrlPrefix : LPCWSTR
    ctypes.c_void_p,  # DataChunk : HTTP_DATA_CHUNK*
    ctypes.c_void_p,  # CachePolicy : HTTP_CACHE_POLICY*
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpAddFragmentToCache = Fiddle::Function.new(
  lib['HttpAddFragmentToCache'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # UrlPrefix : LPCWSTR
    Fiddle::TYPE_VOIDP,  # DataChunk : HTTP_DATA_CHUNK*
    Fiddle::TYPE_VOIDP,  # CachePolicy : HTTP_CACHE_POLICY*
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpAddFragmentToCache(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        UrlPrefix: *const u16,  // LPCWSTR
        DataChunk: *mut HTTP_DATA_CHUNK,  // HTTP_DATA_CHUNK*
        CachePolicy: *mut HTTP_CACHE_POLICY,  // HTTP_CACHE_POLICY*
        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 HttpAddFragmentToCache(IntPtr RequestQueueHandle, [MarshalAs(UnmanagedType.LPWStr)] string UrlPrefix, IntPtr DataChunk, IntPtr CachePolicy, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpAddFragmentToCache' -Namespace Win32 -PassThru
# $api::HttpAddFragmentToCache(RequestQueueHandle, UrlPrefix, DataChunk, CachePolicy, Overlapped)

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

出力引数:

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