HttpReceiveRequestEntityBody

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

HttpReceiveRequestEntityBody RequestQueueHandle, RequestId, Flags, EntityBuffer, EntityBufferLength, BytesReturned, Overlapped

RequestQueueHandle : [intptr] 指定エンティティボディデータを取得するリクエストキューへのハンドル。リクエストキューは HttpCreateRequestQueue で作成される。Windows Server 2003 SP1 および Windows XP SP2 ではハンドルは HttpCreateHttpHandle により作成される。
RequestId : [int64] 取得するエンティティボディを含む HTTP リクエストの識別子。HttpReceiveHttpRequest で返される HTTP_REQUEST の RequestId メンバの値。HTTP_NULL_ID は不可。
Flags : [int] 次のフラグ値を指定できる。Windows Server 2003 SP1 および Windows XP SP2 ではこのパラメータは予約されており 0 でなければならない。このドキュメントは省略されている。
EntityBuffer : [intptr] エンティティボディデータを受け取るバッファへのポインタ。
EntityBufferLength : [int] pBuffer が指すバッファのサイズ (バイト単位)。
BytesReturned : [var] 任意。pBuffer に返されるエンティティボディデータのバイトサイズを受け取る変数へのポインタ。非同期呼び出し時は NULL にし、同期呼び出し時は有効なアドレスが必要である。
Overlapped : [var] 非同期呼び出しの場合は pOverlapped に OVERLAPPED 構造体へのポインタを設定する。同期呼び出しの場合は NULL にする。

(プラグイン / モジュール : httpapi.dll)

解説

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

[戻り値]
関数が成功すると戻り値は NO_ERROR となる。非同期で使用した場合 ERROR_IO_PENDING
は次のリクエストがまだ準備できていないことを示す。関数が失敗した場合、戻り値は次のいずれかのエラーコードとなる。このドキュメントは省略されている。

[備考]
エンティティボディ全体を取得するには、新しいバッファを渡しながら関数が ERROR_HANDLE_EOF を返すまで
HttpReceiveRequestEntityBody
を呼び続ける。バッファ一杯のエンティティボディが正常にコピーされ、まだ残りがある場合は NO_ERROR を返す。

情報