Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
RequestQueueHandleHANDLEin
UrlPrefixLPCWSTRin
DataChunkHTTP_DATA_CHUNK*in
CachePolicyHTTP_CACHE_POLICY*in
OverlappedOVERLAPPED*inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; DWORD HttpAddFragmentToCache(HANDLE RequestQueueHandle, LPCWSTR UrlPrefix, HTTP_DATA_CHUNK* DataChunk, HTTP_CACHE_POLICY* CachePolicy, OVERLAPPED* Overlapped)
#uselib "HTTPAPI.dll"
#cfunc global HttpAddFragmentToCache "HttpAddFragmentToCache" intptr, wstr, var, var, var
; res = HttpAddFragmentToCache(RequestQueueHandle, UrlPrefix, DataChunk, CachePolicy, Overlapped)
; RequestQueueHandle : HANDLE -> "intptr"
; UrlPrefix : LPCWSTR -> "wstr"
; DataChunk : HTTP_DATA_CHUNK* -> "var"
; CachePolicy : HTTP_CACHE_POLICY* -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	httpapi = windows.NewLazySystemDLL("HTTPAPI.dll")
	procHttpAddFragmentToCache = httpapi.NewProc("HttpAddFragmentToCache")
)

// RequestQueueHandle (HANDLE), UrlPrefix (LPCWSTR), DataChunk (HTTP_DATA_CHUNK*), CachePolicy (HTTP_CACHE_POLICY*), Overlapped (OVERLAPPED* optional, in/out)
r1, _, err := procHttpAddFragmentToCache.Call(
	uintptr(RequestQueueHandle),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(UrlPrefix))),
	uintptr(DataChunk),
	uintptr(CachePolicy),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function HttpAddFragmentToCache(
  RequestQueueHandle: THandle;   // HANDLE
  UrlPrefix: PWideChar;   // LPCWSTR
  DataChunk: Pointer;   // HTTP_DATA_CHUNK*
  CachePolicy: Pointer;   // HTTP_CACHE_POLICY*
  Overlapped: Pointer   // OVERLAPPED* optional, in/out
): DWORD; stdcall;
  external 'HTTPAPI.dll' name 'HttpAddFragmentToCache';
result := DllCall("HTTPAPI\HttpAddFragmentToCache"
    , "Ptr", RequestQueueHandle   ; HANDLE
    , "WStr", UrlPrefix   ; LPCWSTR
    , "Ptr", DataChunk   ; HTTP_DATA_CHUNK*
    , "Ptr", CachePolicy   ; HTTP_CACHE_POLICY*
    , "Ptr", Overlapped   ; OVERLAPPED* optional, in/out
    , "UInt")   ; return: DWORD
●HttpAddFragmentToCache(RequestQueueHandle, UrlPrefix, DataChunk, CachePolicy, Overlapped) = DLL("HTTPAPI.dll", "dword HttpAddFragmentToCache(void*, char*, void*, void*, void*)")
# 呼び出し: HttpAddFragmentToCache(RequestQueueHandle, UrlPrefix, DataChunk, CachePolicy, Overlapped)
# RequestQueueHandle : HANDLE -> "void*"
# UrlPrefix : LPCWSTR -> "char*"
# DataChunk : HTTP_DATA_CHUNK* -> "void*"
# CachePolicy : HTTP_CACHE_POLICY* -> "void*"
# Overlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。