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

WinHttpReceiveResponse

関数
送信した要求に対するHTTP応答を受信する。
DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL WinHttpReceiveResponse(
    void* hRequest,
    void* lpReserved
);

パラメーター

名前方向説明
hRequestvoid*inoutHINTERNET ハンドル。 WinHttpOpenRequest によって返され、 WinHttpSendRequest によって送信されます。WinHttpReceiveResponse を呼び出す前に、このハンドルに対する WinHttpSendRequest が完了するまで待機してください。
lpReservedvoid*inoutこのパラメーターは予約されており、NULL でなければなりません。

戻り値の型: BOOL

公式ドキュメント

WinHttpReceiveResponse 関数は、WinHttpSendRequest によって開始された HTTP リクエストへの応答の受信を待機します。

戻り値

成功した場合は TRUE、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。返されるエラーコードには次のものがあります。

エラーコード 説明
ERROR_WINHTTP_CANNOT_CONNECT
サーバーへの接続が失敗した場合に返されます。
ERROR_WINHTTP_CHUNKED_ENCODING_HEADER_SIZE_OVERFLOW
チャンク エンコーディングの解析中にオーバーフロー状態が発生した場合に返されます。
ERROR_WINHTTP_CLIENT_AUTH_CERT_NEEDED
サーバーがクライアント認証を要求した場合に返されます。
ERROR_WINHTTP_CONNECTION_ERROR
サーバーとの接続がリセットまたは終了されたか、互換性のない SSL プロトコルが検出されました。たとえば、WinHTTP バージョン 5.1 は、クライアントが明示的に有効にしない限り SSL2 をサポートしません。
ERROR_WINHTTP_HEADER_COUNT_EXCEEDED
応答に含まれるヘッダーの数が、WinHTTP が受信できる数を超えた場合に返されます。
ERROR_WINHTTP_HEADER_SIZE_OVERFLOW
受信したヘッダーのサイズがリクエスト ハンドルの上限を超えた場合に、WinHttpReceiveResponse によって返されます。
ERROR_WINHTTP_INCORRECT_HANDLE_STATE
指定されたハンドルが正しい状態にないため、要求された操作を実行できません。
ERROR_WINHTTP_INCORRECT_HANDLE_TYPE
指定されたハンドルの種類が、この操作には正しくありません。
ERROR_WINHTTP_INTERNAL_ERROR
内部エラーが発生しました。
ERROR_WINHTTP_INVALID_SERVER_RESPONSE
サーバーの応答を解析できませんでした。
ERROR_WINHTTP_INVALID_URL
URL が無効です。
ERROR_WINHTTP_LOGIN_FAILURE
ログインの試行が失敗しました。このエラーが発生した場合、リクエスト ハンドルを WinHttpCloseHandle で閉じる必要があります。このエラーを最初に発生させた関数を再試行する前に、新しいリクエスト ハンドルを作成する必要があります。
ERROR_WINHTTP_NAME_NOT_RESOLVED
サーバー名を解決できませんでした。
ERROR_WINHTTP_OPERATION_CANCELLED
操作がキャンセルされました。通常は、リクエストが動作していたハンドルが操作の完了前に閉じられたためです。
ERROR_WINHTTP_REDIRECT_FAILED
スキームが変更されたか、リダイレクトのすべての試行が失敗したため (既定は 5 回)、リダイレクトに失敗しました。
ERROR_WINHTTP_RESEND_REQUEST
WinHTTP 関数が失敗しました。目的の関数は、同じリクエスト ハンドルで再試行できます。
ERROR_WINHTTP_RESPONSE_DRAIN_OVERFLOW
受信した応答が WinHTTP の内部サイズ制限を超えた場合に返されます。
ERROR_WINHTTP_SECURE_FAILURE
サーバーが送信した Secure Sockets Layer (SSL) 証明書に 1 つ以上のエラーが見つかりました。発生したエラーの種類を判別するには、ステータス コールバック関数で WINHTTP_CALLBACK_STATUS_SECURE_FAILURE 通知を確認します。詳細については、 WINHTTP_STATUS_CALLBACK を参照してください。
ERROR_WINHTTP_TIMEOUT
リクエストがタイムアウトしました。
ERROR_WINHTTP_UNRECOGNIZED_SCHEME
URL に "http:" または "https:" 以外のスキームが指定されました。
ERROR_NOT_ENOUGH_MEMORY
要求された操作を完了するのに十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

WinHTTP が非同期モードで使用されている場合 (つまり、WinHttpOpenWINHTTP_FLAG_ASYNC が設定されている場合) でも、この関数は同期的にも非同期的にも動作できます。この関数が FALSE を返した場合、この関数は失敗しており、 GetLastError を呼び出して拡張エラー情報を取得できます。この関数が TRUE を返した場合、アプリケーションは、成功を示す WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE 完了コールバック、または操作が非同期的に完了したが失敗したことを示す WINHTTP_CALLBACK_STATUS_REQUEST_ERROR 完了コールバックのいずれかを想定する必要があります。

WinHttpSetStatusCallback でステータス コールバック関数がインストールされている場合、WinHttpSetStatusCallbackdwNotificationFlags パラメーターで設定された次の通知のうち、設定されているものが応答の受信の進行状況を示します。

サーバーが接続を閉じた場合、WinHttpSetStatusCallbackdwNotificationFlags パラメーターで設定されていれば、次の通知も報告されます。
注意 Windows XP および Windows 2000 については、WinHttp スタート ページの Run-Time Requirements セクションを参照してください。

この例は、HTTP サーバーにデータを書き込むコードを示しています。例で指定されているサーバー名 www.wingtiptoys.com は架空のものであり、書き込みアクセス権を持つサーバーの名前に置き換える必要があります。

    LPSTR pszData = "WinHttpWriteData Example";
    DWORD dwBytesWritten = 0;
    BOOL  bResults = FALSE;
    HINTERNET hSession = NULL,
              hConnect = NULL,
              hRequest = NULL;

    // Use WinHttpOpen to obtain a session handle.
    hSession = WinHttpOpen(  L"A WinHTTP Example Program/1.0", 
                             WINHTTP_ACCESS_TYPE_DEFAULT_PROXY,
                             WINHTTP_NO_PROXY_NAME, 
                             WINHTTP_NO_PROXY_BYPASS, 0);

    // Specify an HTTP server.
    if (hSession)
        hConnect = WinHttpConnect( hSession, L"www.wingtiptoys.com",
                                   INTERNET_DEFAULT_HTTP_PORT, 0);

    // Create an HTTP Request handle.
    if (hConnect)
        hRequest = WinHttpOpenRequest( hConnect, L"PUT", 
                                       L"/writetst.txt", 
                                       NULL, WINHTTP_NO_REFERER, 
                                       WINHTTP_DEFAULT_ACCEPT_TYPES, 
                                       0);

    // Send a Request.
    if (hRequest) 
        bResults = WinHttpSendRequest( hRequest, 
                                       WINHTTP_NO_ADDITIONAL_HEADERS,
                                       0, WINHTTP_NO_REQUEST_DATA, 0, 
                                       (DWORD)strlen(pszData), 0);

    // Write data to the server.
    if (bResults)
        bResults = WinHttpWriteData( hRequest, pszData, 
                                     (DWORD)strlen(pszData), 
                                     &dwBytesWritten);

    // End the request.
    if (bResults)
        bResults = WinHttpReceiveResponse( hRequest, NULL);

    // Report any errors.
    if (!bResults)
        printf("Error %d has occurred.\n",GetLastError());


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

各言語での呼び出し定義

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

BOOL WinHttpReceiveResponse(
    void* hRequest,
    void* lpReserved
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WinHttpReceiveResponse(
    IntPtr hRequest,   // void* in/out
    IntPtr lpReserved   // void* in/out
);
<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpReceiveResponse(
    hRequest As IntPtr,   ' void* in/out
    lpReserved As IntPtr   ' void* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hRequest : void* in/out
' lpReserved : void* in/out
Declare PtrSafe Function WinHttpReceiveResponse Lib "winhttp" ( _
    ByVal hRequest As LongPtr, _
    ByVal lpReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpReceiveResponse = ctypes.windll.winhttp.WinHttpReceiveResponse
WinHttpReceiveResponse.restype = wintypes.BOOL
WinHttpReceiveResponse.argtypes = [
    ctypes.POINTER(None),  # hRequest : void* in/out
    ctypes.POINTER(None),  # lpReserved : void* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpReceiveResponse = Fiddle::Function.new(
  lib['WinHttpReceiveResponse'],
  [
    Fiddle::TYPE_VOIDP,  # hRequest : void* in/out
    Fiddle::TYPE_VOIDP,  # lpReserved : void* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpReceiveResponse(
        hRequest: *mut (),  // void* in/out
        lpReserved: *mut ()  // void* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern bool WinHttpReceiveResponse(IntPtr hRequest, IntPtr lpReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpReceiveResponse' -Namespace Win32 -PassThru
# $api::WinHttpReceiveResponse(hRequest, lpReserved)
#uselib "WINHTTP.dll"
#func global WinHttpReceiveResponse "WinHttpReceiveResponse" sptr, sptr
; WinHttpReceiveResponse hRequest, lpReserved   ; 戻り値は stat
; hRequest : void* in/out -> "sptr"
; lpReserved : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINHTTP.dll"
#cfunc global WinHttpReceiveResponse "WinHttpReceiveResponse" sptr, sptr
; res = WinHttpReceiveResponse(hRequest, lpReserved)
; hRequest : void* in/out -> "sptr"
; lpReserved : void* in/out -> "sptr"
; BOOL WinHttpReceiveResponse(void* hRequest, void* lpReserved)
#uselib "WINHTTP.dll"
#cfunc global WinHttpReceiveResponse "WinHttpReceiveResponse" intptr, intptr
; res = WinHttpReceiveResponse(hRequest, lpReserved)
; hRequest : void* in/out -> "intptr"
; lpReserved : void* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpReceiveResponse = winhttp.NewProc("WinHttpReceiveResponse")
)

// hRequest (void* in/out), lpReserved (void* in/out)
r1, _, err := procWinHttpReceiveResponse.Call(
	uintptr(hRequest),
	uintptr(lpReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WinHttpReceiveResponse(
  hRequest: Pointer;   // void* in/out
  lpReserved: Pointer   // void* in/out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpReceiveResponse';
result := DllCall("WINHTTP\WinHttpReceiveResponse"
    , "Ptr", hRequest   ; void* in/out
    , "Ptr", lpReserved   ; void* in/out
    , "Int")   ; return: BOOL
●WinHttpReceiveResponse(hRequest, lpReserved) = DLL("WINHTTP.dll", "bool WinHttpReceiveResponse(void*, void*)")
# 呼び出し: WinHttpReceiveResponse(hRequest, lpReserved)
# hRequest : void* in/out -> "void*"
# lpReserved : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winhttp" fn WinHttpReceiveResponse(
    hRequest: ?*anyopaque, // void* in/out
    lpReserved: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;
proc WinHttpReceiveResponse(
    hRequest: pointer,  # void* in/out
    lpReserved: pointer  # void* in/out
): int32 {.importc: "WinHttpReceiveResponse", stdcall, dynlib: "WINHTTP.dll".}
pragma(lib, "winhttp");
extern(Windows)
int WinHttpReceiveResponse(
    void* hRequest,   // void* in/out
    void* lpReserved   // void* in/out
);
ccall((:WinHttpReceiveResponse, "WINHTTP.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}),
      hRequest, lpReserved)
# hRequest : void* in/out -> Ptr{Cvoid}
# lpReserved : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WinHttpReceiveResponse(
    void* hRequest,
    void* lpReserved);
]]
local winhttp = ffi.load("winhttp")
-- winhttp.WinHttpReceiveResponse(hRequest, lpReserved)
-- hRequest : void* in/out
-- lpReserved : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINHTTP.dll');
const WinHttpReceiveResponse = lib.func('__stdcall', 'WinHttpReceiveResponse', 'int32_t', ['void *', 'void *']);
// WinHttpReceiveResponse(hRequest, lpReserved)
// hRequest : void* in/out -> 'void *'
// lpReserved : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINHTTP.dll", {
  WinHttpReceiveResponse: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.WinHttpReceiveResponse(hRequest, lpReserved)
// hRequest : void* in/out -> "pointer"
// lpReserved : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WinHttpReceiveResponse(
    void* hRequest,
    void* lpReserved);
C, "WINHTTP.dll");
// $ffi->WinHttpReceiveResponse(hRequest, lpReserved);
// hRequest : void* in/out
// lpReserved : void* in/out
// 構造体/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 Winhttp extends StdCallLibrary {
    Winhttp INSTANCE = Native.load("winhttp", Winhttp.class);
    boolean WinHttpReceiveResponse(
        Pointer hRequest,   // void* in/out
        Pointer lpReserved   // void* in/out
    );
}
@[Link("winhttp")]
lib LibWINHTTP
  fun WinHttpReceiveResponse = WinHttpReceiveResponse(
    hRequest : Void*,   # void* in/out
    lpReserved : Void*   # void* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WinHttpReceiveResponseNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef WinHttpReceiveResponseDart = int Function(Pointer<Void>, Pointer<Void>);
final WinHttpReceiveResponse = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpReceiveResponseNative, WinHttpReceiveResponseDart>('WinHttpReceiveResponse');
// hRequest : void* in/out -> Pointer<Void>
// lpReserved : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpReceiveResponse(
  hRequest: Pointer;   // void* in/out
  lpReserved: Pointer   // void* in/out
): BOOL; stdcall;
  external 'WINHTTP.dll' name 'WinHttpReceiveResponse';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpReceiveResponse"
  c_WinHttpReceiveResponse :: Ptr () -> Ptr () -> IO CInt
-- hRequest : void* in/out -> Ptr ()
-- lpReserved : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpreceiveresponse =
  foreign "WinHttpReceiveResponse"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hRequest : void* in/out -> (ptr void) *)
(* lpReserved : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpReceiveResponse" win-http-receive-response :convention :stdcall) :int32
  (h-request :pointer)   ; void* in/out
  (lp-reserved :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpReceiveResponse = Win32::API::More->new('WINHTTP',
    'BOOL WinHttpReceiveResponse(LPVOID hRequest, LPVOID lpReserved)');
# my $ret = $WinHttpReceiveResponse->Call($hRequest, $lpReserved);
# hRequest : void* in/out -> LPVOID
# lpReserved : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目