ホーム › Networking.WinInet › HttpSendRequestExA

HttpSendRequestExA

関数

バッファ指定でHTTPリクエスト送信を開始する(ANSI版)。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
hRequest	void*	in	HttpOpenRequest 関数の呼び出しによって返されたハンドル。
lpBuffersIn	INTERNET_BUFFERSA*	inoptional	省略可能。INTERNET_BUFFERS 構造体へのポインター。
lpBuffersOut	INTERNET_BUFFERSA*	outoptional	予約済み。NULL である必要があります。
dwFlags	DWORD	in	予約済み。ゼロである必要があります。
dwContext	UINT_PTR	inoptional	ステータスコールバック関数が登録されている場合の、アプリケーション定義のコンテキスト値。

戻り値の型: BOOL

公式ドキュメント

指定したリクエストを HTTP サーバーに送信します。(HttpSendRequestExA)

戻り値

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

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

解説(Remarks)

HttpSendRequestEx は、リクエストの送信とレスポンスの受信の両方を実行します。この関数では、HttpSendRequestEx に渡された単一のバッファーを超える追加データをアプリケーションが送信することはできません。通常 HttpSendRequestEx に渡せる以上の追加データを送信する必要がある呼び出し元は、代わりに HttpSendRequest を呼び出すことで送信できます。HttpSendRequestEx の呼び出し後、InternetWriteFile を呼び出して残りのデータを送信します。最後に、HttpEndRequest の呼び出しで締めくくります。

注意 HttpSendRequestExA 関数は、送信するデータを ANSI 文字ではなく ISO-8859-1 文字として表します。HttpSendRequestExW 関数は、送信するデータを UTF-16LE 文字に変換された ISO-8859-1 文字として表します。その結果、追加するヘッダーに非 ASCII 文字が含まれる可能性がある場合に HttpSendRequestExW 関数を使用することは決して安全ではありません。代わりに、アプリケーションは Codepage パラメーターを 28591 に設定して MultiByteToWideChar 関数および WideCharToMultiByte 関数を使用し、ANSI 文字と UTF-16LE 文字の間で変換できます。

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

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして HttpSendRequestEx を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 HttpSendRequestExA(
    void* hRequest,
    INTERNET_BUFFERSA* lpBuffersIn,   // optional
    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 HttpSendRequestExA(
    IntPtr hRequest,   // void*
    IntPtr lpBuffersIn,   // INTERNET_BUFFERSA* optional
    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 HttpSendRequestExA(
    hRequest As IntPtr,   ' void*
    lpBuffersIn As IntPtr,   ' INTERNET_BUFFERSA* optional
    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*
' lpBuffersIn : INTERNET_BUFFERSA* optional
' lpBuffersOut : INTERNET_BUFFERSA* optional, out
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function HttpSendRequestExA Lib "wininet" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpBuffersIn 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

HttpSendRequestExA = ctypes.windll.wininet.HttpSendRequestExA
HttpSendRequestExA.restype = wintypes.BOOL
HttpSendRequestExA.argtypes = [
    ctypes.POINTER(None),  # hRequest : void*
    ctypes.c_void_p,  # lpBuffersIn : INTERNET_BUFFERSA* optional
    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')
HttpSendRequestExA = Fiddle::Function.new(
  lib['HttpSendRequestExA'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void*
    Fiddle::TYPE_VOIDP,  # lpBuffersIn : INTERNET_BUFFERSA* optional
    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 HttpSendRequestExA(
        hRequest: *mut (),  // void*
        lpBuffersIn: *mut INTERNET_BUFFERSA,  // INTERNET_BUFFERSA* optional
        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 HttpSendRequestExA(IntPtr hRequest, IntPtr lpBuffersIn, IntPtr lpBuffersOut, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_HttpSendRequestExA' -Namespace Win32 -PassThru
# $api::HttpSendRequestExA(hRequest, lpBuffersIn, lpBuffersOut, dwFlags, dwContext)

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

出力引数:

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