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

WinHttpConnect

関数
指定サーバーへの接続を確立し接続ハンドルを返す。
DLLWINHTTP.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

void* WinHttpConnect(
    void* hSession,
    LPCWSTR pswzServerName,
    WORD nServerPort,
    DWORD dwReserved
);

パラメーター

名前方向説明
hSessionvoid*inout以前の WinHttpOpen の呼び出しによって返された、有効な HINTERNET WinHTTP セッションハンドルです。
pswzServerNameLPCWSTRinHTTP サーバーのホスト名を含む null 終端文字列へのポインターです。ホスト名の代わりに、サイトの IP アドレスを文字列として指定することもできます (例: 10.0.1.45)。 WinHttp は、国際化されたホスト名を Punycode に変換せずには受け付けないことに注意してください。詳細については、国際化ドメイン名 (IDN) の処理を参照してください。
nServerPortWORDin

接続先となるサーバー上の TCP/IP ポートを指定する符号なし整数です。このパラメーターには、任意の有効な TCP/IP ポート番号、または次の値のいずれかを指定できます。

意味
INTERNET_DEFAULT_HTTP_PORT
HTTP サーバーの既定のポート (ポート 80) を使用します。
INTERNET_DEFAULT_HTTPS_PORT
HTTPS サーバーの既定のポート (ポート 443) を使用します。このポートを選択しても、自動的にセキュリティで保護された接続が確立されるわけではありません。セキュリティで保護されたトランザクションのセマンティクスを使用するには、引き続き WinHttpOpenRequestWINHTTP_FLAG_SECURE フラグを指定する必要があります。
INTERNET_DEFAULT_PORT
HTTP にはポート 80 を、セキュア HTTP (HTTPS) にはポート 443 を使用します。
dwReservedDWORDinこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: void*

公式ドキュメント

WinHttpConnect 関数は、HTTP 要求の最初のターゲットサーバーを指定し、そのターゲットに対する HTTP セッションへの HINTERNET 接続ハンドルを返します。

戻り値

接続に成功した場合は HTTP セッションへの有効な接続ハンドルを返し、それ以外の場合は NULL を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。返されるエラーコードには次のものがあります。

エラーコード 説明
ERROR_WINHTTP_INCORRECT_HANDLE_TYPE
指定されたハンドルの種類が、この操作に対して正しくありません。
ERROR_WINHTTP_INTERNAL_ERROR
内部エラーが発生しました。
ERROR_WINHTTP_INVALID_URL
URL が無効です。
ERROR_WINHTTP_OPERATION_CANCELLED
操作がキャンセルされました。通常は、操作が完了する前に、要求が処理されていたハンドルが閉じられたことが原因です。
ERROR_WINHTTP_UNRECOGNIZED_SCHEME
URL スキームを認識できなかったか、サポートされていません。
ERROR_WINHTTP_SHUTDOWN
WinHTTP 関数のサポートがシャットダウンまたはアンロードされています。
ERROR_NOT_ENOUGH_MEMORY
要求された操作を完了するのに十分なメモリがありませんでした。(Windows エラーコード)

解説(Remarks)

WinHTTP を非同期モードで使用している場合 (つまり WinHttpOpenWINHTTP_FLAG_ASYNC が設定されている場合) でも、この関数は同期的に動作します。戻り値は成功または失敗を示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

呼び出し元のアプリケーションは、 WinHttpConnect が返した HINTERNET ハンドルの使用を終えたら、 WinHttpCloseHandle 関数を使用してそのハンドルを閉じる必要があります。

WinHttpConnect はターゲットの HTTP サーバーを指定しますが、要求がリダイレクトされた場合は別のサーバーから応答が返されることがあります。応答を送信したサーバーの URL は、 WinHttpQueryOptionWINHTTP_OPTION_URL フラグとともに呼び出すことで確認できます。

注意 Windows XP および Windows 2000 については、WinHttp スタートページの 実行時の要件のセクションを参照してください。

次の例は、セキュリティで保護されたトランザクションのセマンティクスを使用して、HTTPS サーバーからリソースをダウンロードする方法を示しています。このサンプルコードは、Microsoft Windows HTTP Services (WinHTTP) アプリケーションプログラミングインターフェイス (API) を初期化し、ターゲットの HTTPS サーバーを選択して、このセキュリティで保護されたリソースに対する要求を開いて送信します。 WinHttpQueryDataAvailable を要求ハンドルとともに使用してダウンロード可能なデータ量を判定し、次に WinHttpReadData を使用してそのデータを読み取ります。このプロセスは、ドキュメント全体が取得されて表示されるまで繰り返されます。


    DWORD dwSize = 0;
    DWORD dwDownloaded = 0;
    LPSTR pszOutBuffer;
    BOOL  bResults = FALSE;
    HINTERNET  hSession = NULL, 
               hConnect = NULL,
               hRequest = NULL;

    // Use WinHttpOpen to obtain a session handle.
    hSession = WinHttpOpen( L"WinHTTP Example/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.microsoft.com",
                                   INTERNET_DEFAULT_HTTPS_PORT, 0);

    // Create an HTTP request handle.
    if (hConnect)
        hRequest = WinHttpOpenRequest( hConnect, L"GET", NULL,
                                       NULL, WINHTTP_NO_REFERER, 
                                       WINHTTP_DEFAULT_ACCEPT_TYPES, 
                                       WINHTTP_FLAG_SECURE);

    // Send a request.
    if (hRequest)
        bResults = WinHttpSendRequest( hRequest,
                                       WINHTTP_NO_ADDITIONAL_HEADERS,
                                       0, WINHTTP_NO_REQUEST_DATA, 0, 
                                       0, 0);

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

    // Keep checking for data until there is nothing left.
    if (bResults)
        do 
        {
            // Check for available data.
            dwSize = 0;
            if (!WinHttpQueryDataAvailable( hRequest, &dwSize))
                printf("Error %u in WinHttpQueryDataAvailable.\n", GetLastError());

            // Allocate space for the buffer.
            pszOutBuffer = new char[dwSize+1];
            if (!pszOutBuffer)
            {
                printf("Out of memory\n");
                dwSize=0;
            }
            else
            {
                // Read the Data.
                ZeroMemory(pszOutBuffer, dwSize+1);

                if (!WinHttpReadData( hRequest, (LPVOID)pszOutBuffer, 
                                      dwSize, &dwDownloaded))
                    printf( "Error %u in WinHttpReadData.\n", GetLastError());
                else
                    printf( "%s\n", pszOutBuffer);
            
                // Free the memory allocated to the buffer.
                delete [] pszOutBuffer;
            }

        } while (dwSize > 0);


    // 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>

void* WinHttpConnect(
    void* hSession,
    LPCWSTR pswzServerName,
    WORD nServerPort,
    DWORD dwReserved
);
[DllImport("WINHTTP.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr WinHttpConnect(
    IntPtr hSession,   // void* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pswzServerName,   // LPCWSTR
    ushort nServerPort,   // WORD
    uint dwReserved   // DWORD
);
<DllImport("WINHTTP.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WinHttpConnect(
    hSession As IntPtr,   ' void* in/out
    <MarshalAs(UnmanagedType.LPWStr)> pswzServerName As String,   ' LPCWSTR
    nServerPort As UShort,   ' WORD
    dwReserved As UInteger   ' DWORD
) As IntPtr
End Function
' hSession : void* in/out
' pswzServerName : LPCWSTR
' nServerPort : WORD
' dwReserved : DWORD
Declare PtrSafe Function WinHttpConnect Lib "winhttp" ( _
    ByVal hSession As LongPtr, _
    ByVal pswzServerName As LongPtr, _
    ByVal nServerPort As Integer, _
    ByVal dwReserved As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WinHttpConnect = ctypes.windll.winhttp.WinHttpConnect
WinHttpConnect.restype = ctypes.c_void_p
WinHttpConnect.argtypes = [
    ctypes.POINTER(None),  # hSession : void* in/out
    wintypes.LPCWSTR,  # pswzServerName : LPCWSTR
    ctypes.c_ushort,  # nServerPort : WORD
    wintypes.DWORD,  # dwReserved : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINHTTP.dll')
WinHttpConnect = Fiddle::Function.new(
  lib['WinHttpConnect'],
  [
    Fiddle::TYPE_VOIDP,  # hSession : void* in/out
    Fiddle::TYPE_VOIDP,  # pswzServerName : LPCWSTR
    -Fiddle::TYPE_SHORT,  # nServerPort : WORD
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "winhttp")]
extern "system" {
    fn WinHttpConnect(
        hSession: *mut (),  // void* in/out
        pswzServerName: *const u16,  // LPCWSTR
        nServerPort: u16,  // WORD
        dwReserved: u32  // DWORD
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINHTTP.dll", SetLastError = true)]
public static extern IntPtr WinHttpConnect(IntPtr hSession, [MarshalAs(UnmanagedType.LPWStr)] string pswzServerName, ushort nServerPort, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINHTTP_WinHttpConnect' -Namespace Win32 -PassThru
# $api::WinHttpConnect(hSession, pswzServerName, nServerPort, dwReserved)
#uselib "WINHTTP.dll"
#func global WinHttpConnect "WinHttpConnect" sptr, sptr, sptr, sptr
; WinHttpConnect hSession, pswzServerName, nServerPort, dwReserved   ; 戻り値は stat
; hSession : void* in/out -> "sptr"
; pswzServerName : LPCWSTR -> "sptr"
; nServerPort : WORD -> "sptr"
; dwReserved : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINHTTP.dll"
#cfunc global WinHttpConnect "WinHttpConnect" sptr, wstr, int, int
; res = WinHttpConnect(hSession, pswzServerName, nServerPort, dwReserved)
; hSession : void* in/out -> "sptr"
; pswzServerName : LPCWSTR -> "wstr"
; nServerPort : WORD -> "int"
; dwReserved : DWORD -> "int"
; void* WinHttpConnect(void* hSession, LPCWSTR pswzServerName, WORD nServerPort, DWORD dwReserved)
#uselib "WINHTTP.dll"
#cfunc global WinHttpConnect "WinHttpConnect" intptr, wstr, int, int
; res = WinHttpConnect(hSession, pswzServerName, nServerPort, dwReserved)
; hSession : void* in/out -> "intptr"
; pswzServerName : LPCWSTR -> "wstr"
; nServerPort : WORD -> "int"
; dwReserved : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winhttp = windows.NewLazySystemDLL("WINHTTP.dll")
	procWinHttpConnect = winhttp.NewProc("WinHttpConnect")
)

// hSession (void* in/out), pswzServerName (LPCWSTR), nServerPort (WORD), dwReserved (DWORD)
r1, _, err := procWinHttpConnect.Call(
	uintptr(hSession),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pswzServerName))),
	uintptr(nServerPort),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function WinHttpConnect(
  hSession: Pointer;   // void* in/out
  pswzServerName: PWideChar;   // LPCWSTR
  nServerPort: Word;   // WORD
  dwReserved: DWORD   // DWORD
): Pointer; stdcall;
  external 'WINHTTP.dll' name 'WinHttpConnect';
result := DllCall("WINHTTP\WinHttpConnect"
    , "Ptr", hSession   ; void* in/out
    , "WStr", pswzServerName   ; LPCWSTR
    , "UShort", nServerPort   ; WORD
    , "UInt", dwReserved   ; DWORD
    , "Ptr")   ; return: void*
●WinHttpConnect(hSession, pswzServerName, nServerPort, dwReserved) = DLL("WINHTTP.dll", "void* WinHttpConnect(void*, char*, int, dword)")
# 呼び出し: WinHttpConnect(hSession, pswzServerName, nServerPort, dwReserved)
# hSession : void* in/out -> "void*"
# pswzServerName : LPCWSTR -> "char*"
# nServerPort : WORD -> "int"
# dwReserved : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WinHttpConnectNative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Uint16, Uint32);
typedef WinHttpConnectDart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, int, int);
final WinHttpConnect = DynamicLibrary.open('WINHTTP.dll')
    .lookupFunction<WinHttpConnectNative, WinHttpConnectDart>('WinHttpConnect');
// hSession : void* in/out -> Pointer<Void>
// pswzServerName : LPCWSTR -> Pointer<Utf16>
// nServerPort : WORD -> Uint16
// dwReserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WinHttpConnect(
  hSession: Pointer;   // void* in/out
  pswzServerName: PWideChar;   // LPCWSTR
  nServerPort: Word;   // WORD
  dwReserved: DWORD   // DWORD
): Pointer; stdcall;
  external 'WINHTTP.dll' name 'WinHttpConnect';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WinHttpConnect"
  c_WinHttpConnect :: Ptr () -> CWString -> Word16 -> Word32 -> IO (Ptr ())
-- hSession : void* in/out -> Ptr ()
-- pswzServerName : LPCWSTR -> CWString
-- nServerPort : WORD -> Word16
-- dwReserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let winhttpconnect =
  foreign "WinHttpConnect"
    ((ptr void) @-> (ptr uint16_t) @-> uint16_t @-> uint32_t @-> returning (ptr void))
(* hSession : void* in/out -> (ptr void) *)
(* pswzServerName : LPCWSTR -> (ptr uint16_t) *)
(* nServerPort : WORD -> uint16_t *)
(* dwReserved : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winhttp (t "WINHTTP.dll"))
(cffi:use-foreign-library winhttp)

(cffi:defcfun ("WinHttpConnect" win-http-connect :convention :stdcall) :pointer
  (h-session :pointer)   ; void* in/out
  (pswz-server-name (:string :encoding :utf-16le))   ; LPCWSTR
  (n-server-port :uint16)   ; WORD
  (dw-reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WinHttpConnect = Win32::API::More->new('WINHTTP',
    'LPVOID WinHttpConnect(LPVOID hSession, LPCWSTR pswzServerName, WORD nServerPort, DWORD dwReserved)');
# my $ret = $WinHttpConnect->Call($hSession, $pswzServerName, $nServerPort, $dwReserved);
# hSession : void* in/out -> LPVOID
# pswzServerName : LPCWSTR -> LPCWSTR
# nServerPort : WORD -> WORD
# dwReserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目