ホーム › Networking.WinInet › HttpEndRequestA

HttpEndRequestA

関数

HttpSendRequestExで開始したHTTP要求を完了させる(ANSI版)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL HttpEndRequestA(
    void* hRequest,
    INTERNET_BUFFERSA* lpBuffersOut,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前	型	方向	説明
hRequest	void*	in	HttpOpenRequest によって返され、 HttpSendRequestEx によって送信されたハンドル。
lpBuffersOut	INTERNET_BUFFERSA*	outoptional	このパラメーターは予約されており、NULL でなければなりません。
dwFlags	DWORD	in	このパラメーターは予約されており、0 を設定する必要があります。
dwContext	UINT_PTR	inoptional	このパラメーターは予約されており、0 を設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

lpBuffersOut が NULL に設定されていない場合、 HttpEndRequest は ERROR_INVALID_PARAMETER を返します。

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

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用しないでください。サーバー実装やサービスでは、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

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

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

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL HttpEndRequestA(
    void* hRequest,
    INTERNET_BUFFERSA* lpBuffersOut,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool HttpEndRequestA(
    IntPtr hRequest,   // void*
    IntPtr lpBuffersOut,   // INTERNET_BUFFERSA* optional, out
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function HttpEndRequestA(
    hRequest As IntPtr,   ' void*
    lpBuffersOut As IntPtr,   ' INTERNET_BUFFERSA* optional, out
    dwFlags As UInteger,   ' DWORD
    dwContext As UIntPtr   ' UINT_PTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hRequest : void*
' lpBuffersOut : INTERNET_BUFFERSA* optional, out
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function HttpEndRequestA Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpBuffersOut As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpEndRequestA = ctypes.windll.wininet.HttpEndRequestA
HttpEndRequestA.restype = wintypes.BOOL
HttpEndRequestA.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    ctypes.c_void_p,  # lpBuffersOut : INTERNET_BUFFERSA* 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')
HttpEndRequestA = Fiddle::Function.new(
  lib['HttpEndRequestA'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    Fiddle::TYPE_VOIDP,  # lpBuffersOut : INTERNET_BUFFERSA* optional, out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn HttpEndRequestA(
        hRequest: *mut (),  // void*
        lpBuffersOut: *mut INTERNET_BUFFERSA,  // INTERNET_BUFFERSA* 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.Ansi, SetLastError = true)]
public static extern bool HttpEndRequestA(IntPtr hRequest, IntPtr lpBuffersOut, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpEndRequestA' -Namespace Win32 -PassThru
# $api::HttpEndRequestA(hRequest, lpBuffersOut, dwFlags, dwContext)

#uselib "WININET.dll"
#func global HttpEndRequestA "HttpEndRequestA" sptr, sptr, sptr, sptr
; HttpEndRequestA hRequest, varptr(lpBuffersOut), dwFlags, dwContext   ; 戻り値は stat
; hRequest : void* -> "sptr"
; lpBuffersOut : INTERNET_BUFFERSA* optional, out -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global HttpEndRequestA "HttpEndRequestA" sptr, var, int, sptr
; res = HttpEndRequestA(hRequest, lpBuffersOut, dwFlags, dwContext)
; hRequest : void* -> "sptr"
; lpBuffersOut : INTERNET_BUFFERSA* optional, out -> "var"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global HttpEndRequestA "HttpEndRequestA" sptr, sptr, int, sptr
; res = HttpEndRequestA(hRequest, varptr(lpBuffersOut), dwFlags, dwContext)
; hRequest : void* -> "sptr"
; lpBuffersOut : INTERNET_BUFFERSA* optional, out -> "sptr"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。