ホーム › Networking.HttpServer › HttpReadFragmentFromCache

HttpReadFragmentFromCache

関数

キャッシュから応答フラグメントを読み取る。

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

シグネチャ

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

DWORD HttpReadFragmentFromCache(
    HANDLE RequestQueueHandle,
    LPCWSTR UrlPrefix,
    HTTP_BYTE_RANGE* ByteRange,   // optional
    void* Buffer,
    DWORD BufferLength,
    DWORD* BytesRead,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前	型	方向	説明
RequestQueueHandle	HANDLE	in	指定したレスポンスフラグメントが関連付けられているリクエストキューへのハンドル。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。 Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。
UrlPrefix	LPCWSTR	in	取得するフラグメントの名前を含む UrlPrefix 文字列へのポインター。これは、過去に成功した HttpAddFragmentToCache の呼び出しで使用した UrlPrefix 文字列と一致している必要があります。
ByteRange	HTTP_BYTE_RANGE*	inoptional	指定したフラグメント内の開始オフセットと、返されるバイト数を示す HTTP_BYTE_RANGE 構造体への省略可能なポインター。使用しない場合は NULL を指定し、その場合はフラグメント全体が返されます。
Buffer	void*	out	要求されたフラグメントを関数がコピーするバッファーへのポインター。
BufferLength	DWORD	in	pBuffer バッファーのサイズ(バイト単位)。
BytesRead	DWORD*	outoptional	出力バッファーに書き込まれるバイト数を受け取る変数への省略可能なポインター。BufferLength がこの値より小さい場合、呼び出しは ERROR_INSUFFICIENT_BUFFER を返して失敗し、pBytesRead が指す値を使用して、呼び出しを成功させるために必要な最小バッファー長を判断できます。 pOverlapped を使用して非同期呼び出しを行う場合は、pBytesRead を NULL に設定します。一方、pOverlapped が NULL に設定されている場合、pBytesRead は有効なメモリアドレスを含む必要があり、NULL に設定してはなりません。
Overlapped	OVERLAPPED*	inoutoptional	非同期呼び出しの場合は pOverlapped に OVERLAPPED 構造体を指すように設定し、同期呼び出しの場合は NULL に設定します。同期呼び出しはキャッシュ操作が完了するまでブロックされますが、非同期呼び出しは直ちに ERROR_IO_PENDING を返し、呼び出し側のアプリケーションはその後 GetOverlappedResult または I/O 完了ポートを使用して操作の完了時期を判断します。同期処理のための OVERLAPPED 構造体の使用方法の詳細については、Synchronization and Overlapped Input and Output を参照してください。

戻り値の型: DWORD

公式ドキュメント

HttpReadFragmentFromCache 関数は、指定した名前を持つレスポンスフラグメントを HTTP Server API のキャッシュから取得します。

戻り値

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

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

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

値	意味
ERROR_INVALID_PARAMETER	指定したパラメーターのうち 1 つ以上が使用できない形式です。
ERROR_MORE_DATA	pBuffer が指すバッファーが小さすぎて、要求されたすべてのデータを受け取れません。必要なバッファーのサイズは、pBytesRead が NULL であるか呼び出しが非同期である場合を除き、pBytesRead によって指されます。非同期呼び出しの場合、 GetOverLappedResult 関数の lpNumberOfBytesTransferred パラメーターが指す値に、必要なバッファーサイズが設定されます。
その他	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 HttpReadFragmentFromCache(
    HANDLE RequestQueueHandle,
    LPCWSTR UrlPrefix,
    HTTP_BYTE_RANGE* ByteRange,   // optional
    void* Buffer,
    DWORD BufferLength,
    DWORD* BytesRead,   // optional
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpReadFragmentFromCache(
    IntPtr RequestQueueHandle,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string UrlPrefix,   // LPCWSTR
    IntPtr ByteRange,   // HTTP_BYTE_RANGE* optional
    IntPtr Buffer,   // void* out
    uint BufferLength,   // DWORD
    IntPtr BytesRead,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);

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

' RequestQueueHandle : HANDLE
' UrlPrefix : LPCWSTR
' ByteRange : HTTP_BYTE_RANGE* optional
' Buffer : void* out
' BufferLength : DWORD
' BytesRead : DWORD* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpReadFragmentFromCache Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal UrlPrefix As LongPtr, _
    ByVal ByteRange As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByVal BufferLength As Long, _
    ByVal BytesRead 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

HttpReadFragmentFromCache = ctypes.windll.httpapi.HttpReadFragmentFromCache
HttpReadFragmentFromCache.restype = wintypes.DWORD
HttpReadFragmentFromCache.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    wintypes.LPCWSTR,  # UrlPrefix : LPCWSTR
    ctypes.c_void_p,  # ByteRange : HTTP_BYTE_RANGE* optional
    ctypes.POINTER(None),  # Buffer : void* out
    wintypes.DWORD,  # BufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesRead : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpReadFragmentFromCache = Fiddle::Function.new(
  lib['HttpReadFragmentFromCache'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # UrlPrefix : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ByteRange : HTTP_BYTE_RANGE* optional
    Fiddle::TYPE_VOIDP,  # Buffer : void* out
    -Fiddle::TYPE_INT,  # BufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # BytesRead : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpReadFragmentFromCache(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        UrlPrefix: *const u16,  // LPCWSTR
        ByteRange: *mut HTTP_BYTE_RANGE,  // HTTP_BYTE_RANGE* optional
        Buffer: *mut (),  // void* out
        BufferLength: u32,  // DWORD
        BytesRead: *mut u32,  // DWORD* optional, out
        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 HttpReadFragmentFromCache(IntPtr RequestQueueHandle, [MarshalAs(UnmanagedType.LPWStr)] string UrlPrefix, IntPtr ByteRange, IntPtr Buffer, uint BufferLength, IntPtr BytesRead, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpReadFragmentFromCache' -Namespace Win32 -PassThru
# $api::HttpReadFragmentFromCache(RequestQueueHandle, UrlPrefix, ByteRange, Buffer, BufferLength, BytesRead, Overlapped)

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

出力引数:

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