ホーム › Networking.HttpServer › HttpReceiveRequestEntityBody

HttpReceiveRequestEntityBody

関数

HTTPリクエストのエンティティ本文を受信する。

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

シグネチャ

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

DWORD HttpReceiveRequestEntityBody(
    HANDLE RequestQueueHandle,
    ULONGLONG RequestId,
    DWORD Flags,
    void* EntityBuffer,
    DWORD EntityBufferLength,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前

型

方向

説明

RequestQueueHandle

HANDLE

指定したエンティティボディデータを取得するリクエストキューへのハンドルです。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。

Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。

RequestId

ULONGLONG

取得対象のエンティティボディを含む HTTP リクエストの識別子です。この値は、 HttpReceiveHttpRequest 関数の呼び出しによって HTTP_REQUEST 構造体の RequestId メンバーに返されます。この値は HTTP_NULL_ID にはできません。

Flags

DWORD

このパラメーターには次のフラグ値を指定できます。

Windows Server 2003 with SP1 および Windows XP with SP2: このパラメーターは予約済みであり、ゼロを指定する必要があります。

値	意味
HTTP_RECEIVE_REQUEST_ENTITY_BODY_FLAG_FILL_BUFFER	コピーすべき残りのエンティティボディが存在しない場合を除き、バッファーを 1 つ以上のエンティティボディで満たすことを指定します。

EntityBuffer

void*

out

エンティティボディデータを受け取るバッファーへのポインターです。

EntityBufferLength

DWORD

pBuffer パラメーターが指すバッファーのサイズ (バイト単位) です。

BytesReturned

DWORD*

outoptional

省略可能です。pBuffer バッファーに返されたエンティティボディデータのサイズ (バイト単位) を受け取る変数へのポインターです。

pOverlapped を使用して非同期呼び出しを行う場合は、pBytesReceived を NULL に設定します。それ以外の場合、pOverlapped が NULL に設定されているときは、pBytesReceived は有効なメモリアドレスを含む必要があり、NULL に設定してはなりません。

Overlapped

OVERLAPPED*

inoutoptional

非同期呼び出しの場合は、pOverlapped が OVERLAPPED 構造体を指すように設定します。同期呼び出しの場合は NULL に設定します。

同期呼び出しはエンティティボディデータが取得されるまでブロックしますが、非同期呼び出しは直ちに ERROR_IO_PENDING を返し、呼び出し元のアプリケーションはその後 GetOverlappedResult または I/O 完了ポートを使用して、操作がいつ完了したかを判断します。同期のために OVERLAPPED 構造体を使用する方法の詳細については、Synchronization and Overlapped Input and Output を参照してください。

戻り値の型: DWORD

公式ドキュメント

指定した HTTP リクエストの追加のエンティティボディデータを受信します。

戻り値

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

関数を非同期に使用した場合、戻り値 ERROR_IO_PENDING は、次のリクエストがまだ準備できておらず、後で通常のオーバーラップ I/O 完了メカニズムによって取得されることを示します。

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

値	意味
ERROR_INVALID_PARAMETER	指定されたパラメーターの 1 つ以上が使用できない形式です。
ERROR_HANDLE_EOF	指定したエンティティボディはすでに完全に取得されています。この場合、pBytesReceived が指す値は意味を持たず、pBuffer を参照しないでください。
ERROR_DLL_INIT_FAILED	呼び出し元のアプリケーションが、この関数を呼び出す前に HttpInitialize を呼び出していません。
その他	WinError.h で定義されているシステムエラーコードです。

解説(Remarks)

エンティティボディ全体を取得するには、アプリケーションは関数が ERROR_HANDLE_EOF を返すまで、新しいバッファーを渡しながら HttpReceiveRequestEntityBody を繰り返し呼び出す必要があります。バッファーいっぱいのエンティティボディデータが正常にコピーされ、まだ取得待ちのエンティティボディデータが残っている間は、関数は NO_ERROR を返します。

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

各言語での呼び出し定義

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

DWORD HttpReceiveRequestEntityBody(
    HANDLE RequestQueueHandle,
    ULONGLONG RequestId,
    DWORD Flags,
    void* EntityBuffer,
    DWORD EntityBufferLength,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpReceiveRequestEntityBody(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong RequestId,   // ULONGLONG
    uint Flags,   // DWORD
    IntPtr EntityBuffer,   // void* out
    uint EntityBufferLength,   // DWORD
    IntPtr BytesReturned,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpReceiveRequestEntityBody(
    RequestQueueHandle As IntPtr,   ' HANDLE
    RequestId As ULong,   ' ULONGLONG
    Flags As UInteger,   ' DWORD
    EntityBuffer As IntPtr,   ' void* out
    EntityBufferLength As UInteger,   ' DWORD
    BytesReturned As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As UInteger
End Function

' RequestQueueHandle : HANDLE
' RequestId : ULONGLONG
' Flags : DWORD
' EntityBuffer : void* out
' EntityBufferLength : DWORD
' BytesReturned : DWORD* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpReceiveRequestEntityBody Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal RequestId As LongLong, _
    ByVal Flags As Long, _
    ByVal EntityBuffer As LongPtr, _
    ByVal EntityBufferLength As Long, _
    ByVal BytesReturned 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

HttpReceiveRequestEntityBody = ctypes.windll.httpapi.HttpReceiveRequestEntityBody
HttpReceiveRequestEntityBody.restype = wintypes.DWORD
HttpReceiveRequestEntityBody.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # RequestId : ULONGLONG
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(None),  # EntityBuffer : void* out
    wintypes.DWORD,  # EntityBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesReturned : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpReceiveRequestEntityBody = Fiddle::Function.new(
  lib['HttpReceiveRequestEntityBody'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # RequestId : ULONGLONG
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # EntityBuffer : void* out
    -Fiddle::TYPE_INT,  # EntityBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # BytesReturned : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpReceiveRequestEntityBody(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        RequestId: u64,  // ULONGLONG
        Flags: u32,  // DWORD
        EntityBuffer: *mut (),  // void* out
        EntityBufferLength: u32,  // DWORD
        BytesReturned: *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 HttpReceiveRequestEntityBody(IntPtr RequestQueueHandle, ulong RequestId, uint Flags, IntPtr EntityBuffer, uint EntityBufferLength, IntPtr BytesReturned, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpReceiveRequestEntityBody' -Namespace Win32 -PassThru
# $api::HttpReceiveRequestEntityBody(RequestQueueHandle, RequestId, Flags, EntityBuffer, EntityBufferLength, BytesReturned, Overlapped)

#uselib "HTTPAPI.dll"
#func global HttpReceiveRequestEntityBody "HttpReceiveRequestEntityBody" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HttpReceiveRequestEntityBody RequestQueueHandle, RequestId, Flags, EntityBuffer, EntityBufferLength, varptr(BytesReturned), varptr(Overlapped)   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; RequestId : ULONGLONG -> "sptr"
; Flags : DWORD -> "sptr"
; EntityBuffer : void* out -> "sptr"
; EntityBufferLength : DWORD -> "sptr"
; BytesReturned : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveRequestEntityBody "HttpReceiveRequestEntityBody" sptr, int64, int, sptr, int, var, var
; res = HttpReceiveRequestEntityBody(RequestQueueHandle, RequestId, Flags, EntityBuffer, EntityBufferLength, BytesReturned, Overlapped)
; RequestQueueHandle : HANDLE -> "sptr"
; RequestId : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; EntityBuffer : void* out -> "sptr"
; EntityBufferLength : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveRequestEntityBody "HttpReceiveRequestEntityBody" sptr, int64, int, sptr, int, sptr, sptr
; res = HttpReceiveRequestEntityBody(RequestQueueHandle, RequestId, Flags, EntityBuffer, EntityBufferLength, varptr(BytesReturned), varptr(Overlapped))
; RequestQueueHandle : HANDLE -> "sptr"
; RequestId : ULONGLONG -> "int64"
; Flags : DWORD -> "int"
; EntityBuffer : void* out -> "sptr"
; EntityBufferLength : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。