Win32 API 日本語リファレンス
ホームNetworking.WinInet › HttpEndRequestW

HttpEndRequestW

関数
HttpSendRequestExで開始したHTTP要求を完了させる(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL HttpEndRequestW(
    void* hRequest,
    INTERNET_BUFFERSW* lpBuffersOut,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前方向説明
hRequestvoid*inHttpOpenRequest によって返され、 HttpSendRequestEx によって送信されたハンドル。
lpBuffersOutINTERNET_BUFFERSW*outoptionalこのパラメーターは予約されており、NULL でなければなりません。
dwFlagsDWORDinこのパラメーターは予約されており、0 に設定する必要があります。
dwContextUINT_PTRinoptionalこのパラメーターは予約されており、0 に設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

HttpSendRequestEx によって開始された HTTP 要求を終了します。(Unicode)

戻り値

関数が成功した場合、TRUE を返します。

関数が失敗した場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

lpBuffersOutNULL に設定されていない場合、 HttpEndRequestERROR_INVALID_PARAMETER を返します。

WinINet API の他のすべての側面と同様に、この関数は DllMain 内やグローバルオブジェクトのコンストラクター・デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。さらに、サービスから使用すべきではありません。サーバー実装やサービスでは Microsoft Windows HTTP Services (WinHTTP) を使用してください。
メモ

wininet.h ヘッダーは HttpEndRequest を、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL HttpEndRequestW(
    void* hRequest,
    INTERNET_BUFFERSW* lpBuffersOut,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool HttpEndRequestW(
    IntPtr hRequest,   // void*
    IntPtr lpBuffersOut,   // INTERNET_BUFFERSW* optional, out
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HttpEndRequestW(
    hRequest As IntPtr,   ' void*
    lpBuffersOut As IntPtr,   ' INTERNET_BUFFERSW* optional, out
    dwFlags As UInteger,   ' DWORD
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hRequest : void*
' lpBuffersOut : INTERNET_BUFFERSW* optional, out
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function HttpEndRequestW Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpBuffersOut As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwContext As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HttpEndRequestW = ctypes.windll.wininet.HttpEndRequestW
HttpEndRequestW.restype = wintypes.BOOL
HttpEndRequestW.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    ctypes.c_void_p,  # lpBuffersOut : INTERNET_BUFFERSW* optional, out
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
HttpEndRequestW = Fiddle::Function.new(
  lib['HttpEndRequestW'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    Fiddle::TYPE_VOIDP,  # lpBuffersOut : INTERNET_BUFFERSW* optional, out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn HttpEndRequestW(
        hRequest: *mut (),  // void*
        lpBuffersOut: *mut INTERNET_BUFFERSW,  // INTERNET_BUFFERSW* optional, out
        dwFlags: u32,  // DWORD
        dwContext: usize  // UINT_PTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool HttpEndRequestW(IntPtr hRequest, IntPtr lpBuffersOut, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpEndRequestW' -Namespace Win32 -PassThru
# $api::HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
#uselib "WININET.dll"
#func global HttpEndRequestW "HttpEndRequestW" wptr, wptr, wptr, wptr
; HttpEndRequestW hRequest, varptr(lpBuffersOut), dwFlags, dwContext   ; 戻り値は stat
; hRequest : void* -> "wptr"
; lpBuffersOut : INTERNET_BUFFERSW* optional, out -> "wptr"
; dwFlags : DWORD -> "wptr"
; dwContext : UINT_PTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WININET.dll"
#cfunc global HttpEndRequestW "HttpEndRequestW" sptr, var, int, sptr
; res = HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
; hRequest : void* -> "sptr"
; lpBuffersOut : INTERNET_BUFFERSW* optional, out -> "var"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL HttpEndRequestW(void* hRequest, INTERNET_BUFFERSW* lpBuffersOut, DWORD dwFlags, UINT_PTR dwContext)
#uselib "WININET.dll"
#cfunc global HttpEndRequestW "HttpEndRequestW" intptr, var, int, intptr
; res = HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
; hRequest : void* -> "intptr"
; lpBuffersOut : INTERNET_BUFFERSW* optional, out -> "var"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procHttpEndRequestW = wininet.NewProc("HttpEndRequestW")
)

// hRequest (void*), lpBuffersOut (INTERNET_BUFFERSW* optional, out), dwFlags (DWORD), dwContext (UINT_PTR optional)
r1, _, err := procHttpEndRequestW.Call(
	uintptr(hRequest),
	uintptr(lpBuffersOut),
	uintptr(dwFlags),
	uintptr(dwContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function HttpEndRequestW(
  hRequest: Pointer;   // void*
  lpBuffersOut: Pointer;   // INTERNET_BUFFERSW* optional, out
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpEndRequestW';
result := DllCall("WININET\HttpEndRequestW"
    , "Ptr", hRequest   ; void*
    , "Ptr", lpBuffersOut   ; INTERNET_BUFFERSW* optional, out
    , "UInt", dwFlags   ; DWORD
    , "UPtr", dwContext   ; UINT_PTR optional
    , "Int")   ; return: BOOL
●HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext) = DLL("WININET.dll", "bool HttpEndRequestW(void*, void*, dword, int)")
# 呼び出し: HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
# hRequest : void* -> "void*"
# lpBuffersOut : INTERNET_BUFFERSW* optional, out -> "void*"
# dwFlags : DWORD -> "dword"
# dwContext : UINT_PTR optional -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn HttpEndRequestW(
    hRequest: ?*anyopaque, // void*
    lpBuffersOut: [*c]INTERNET_BUFFERSW, // INTERNET_BUFFERSW* optional, out
    dwFlags: u32, // DWORD
    dwContext: usize // UINT_PTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc HttpEndRequestW(
    hRequest: pointer,  # void*
    lpBuffersOut: ptr INTERNET_BUFFERSW,  # INTERNET_BUFFERSW* optional, out
    dwFlags: uint32,  # DWORD
    dwContext: uint  # UINT_PTR optional
): int32 {.importc: "HttpEndRequestW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int HttpEndRequestW(
    void* hRequest,   // void*
    INTERNET_BUFFERSW* lpBuffersOut,   // INTERNET_BUFFERSW* optional, out
    uint dwFlags,   // DWORD
    size_t dwContext   // UINT_PTR optional
);
ccall((:HttpEndRequestW, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{INTERNET_BUFFERSW}, UInt32, Csize_t),
      hRequest, lpBuffersOut, dwFlags, dwContext)
# hRequest : void* -> Ptr{Cvoid}
# lpBuffersOut : INTERNET_BUFFERSW* optional, out -> Ptr{INTERNET_BUFFERSW}
# dwFlags : DWORD -> UInt32
# dwContext : UINT_PTR optional -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t HttpEndRequestW(
    void* hRequest,
    void* lpBuffersOut,
    uint32_t dwFlags,
    uintptr_t dwContext);
]]
local wininet = ffi.load("wininet")
-- wininet.HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
-- hRequest : void*
-- lpBuffersOut : INTERNET_BUFFERSW* optional, out
-- dwFlags : DWORD
-- dwContext : UINT_PTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const HttpEndRequestW = lib.func('__stdcall', 'HttpEndRequestW', 'int32_t', ['void *', 'void *', 'uint32_t', 'uintptr_t']);
// HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
// hRequest : void* -> 'void *'
// lpBuffersOut : INTERNET_BUFFERSW* optional, out -> 'void *'
// dwFlags : DWORD -> 'uint32_t'
// dwContext : UINT_PTR optional -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  HttpEndRequestW: { parameters: ["pointer", "pointer", "u32", "usize"], result: "i32" },
});
// lib.symbols.HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext)
// hRequest : void* -> "pointer"
// lpBuffersOut : INTERNET_BUFFERSW* optional, out -> "pointer"
// dwFlags : DWORD -> "u32"
// dwContext : UINT_PTR optional -> "usize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HttpEndRequestW(
    void* hRequest,
    void* lpBuffersOut,
    uint32_t dwFlags,
    size_t dwContext);
C, "WININET.dll");
// $ffi->HttpEndRequestW(hRequest, lpBuffersOut, dwFlags, dwContext);
// hRequest : void*
// lpBuffersOut : INTERNET_BUFFERSW* optional, out
// dwFlags : DWORD
// dwContext : UINT_PTR optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.UNICODE_OPTIONS);
    boolean HttpEndRequestW(
        Pointer hRequest,   // void*
        Pointer lpBuffersOut,   // INTERNET_BUFFERSW* optional, out
        int dwFlags,   // DWORD
        long dwContext   // UINT_PTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun HttpEndRequestW = HttpEndRequestW(
    hRequest : Void*,   # void*
    lpBuffersOut : INTERNET_BUFFERSW*,   # INTERNET_BUFFERSW* optional, out
    dwFlags : UInt32,   # DWORD
    dwContext : LibC::SizeT   # UINT_PTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HttpEndRequestWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, UintPtr);
typedef HttpEndRequestWDart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final HttpEndRequestW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<HttpEndRequestWNative, HttpEndRequestWDart>('HttpEndRequestW');
// hRequest : void* -> Pointer<Void>
// lpBuffersOut : INTERNET_BUFFERSW* optional, out -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// dwContext : UINT_PTR optional -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HttpEndRequestW(
  hRequest: Pointer;   // void*
  lpBuffersOut: Pointer;   // INTERNET_BUFFERSW* optional, out
  dwFlags: DWORD;   // DWORD
  dwContext: NativeUInt   // UINT_PTR optional
): BOOL; stdcall;
  external 'WININET.dll' name 'HttpEndRequestW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HttpEndRequestW"
  c_HttpEndRequestW :: Ptr () -> Ptr () -> Word32 -> CUIntPtr -> IO CInt
-- hRequest : void* -> Ptr ()
-- lpBuffersOut : INTERNET_BUFFERSW* optional, out -> Ptr ()
-- dwFlags : DWORD -> Word32
-- dwContext : UINT_PTR optional -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let httpendrequestw =
  foreign "HttpEndRequestW"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> size_t @-> returning int32_t)
(* hRequest : void* -> (ptr void) *)
(* lpBuffersOut : INTERNET_BUFFERSW* optional, out -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* dwContext : UINT_PTR optional -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("HttpEndRequestW" http-end-request-w :convention :stdcall) :int32
  (h-request :pointer)   ; void*
  (lp-buffers-out :pointer)   ; INTERNET_BUFFERSW* optional, out
  (dw-flags :uint32)   ; DWORD
  (dw-context :uint64))   ; UINT_PTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HttpEndRequestW = Win32::API::More->new('WININET',
    'BOOL HttpEndRequestW(LPVOID hRequest, LPVOID lpBuffersOut, DWORD dwFlags, WPARAM dwContext)');
# my $ret = $HttpEndRequestW->Call($hRequest, $lpBuffersOut, $dwFlags, $dwContext);
# hRequest : void* -> LPVOID
# lpBuffersOut : INTERNET_BUFFERSW* optional, out -> LPVOID
# dwFlags : DWORD -> DWORD
# dwContext : UINT_PTR optional -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型