WinHttpConnect 関数 (winhttp.h)

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

構文

WINHTTPAPI HINTERNET WinHttpConnect(
  [in] HINTERNET     hSession,
  [in] LPCWSTR       pswzServerName,
  [in] INTERNET_PORT nServerPort,
  [in] DWORD         dwReserved
);

パラメーター

[in] hSession

有効な HINTERNET WinHttpOpenへの以前の呼び出しによって返された WinHTTP セッション ハンドル します。

[in] pswzServerName

HTTP サーバーのホスト名を含む null-terminated 文字列へのポインター。 または、10.0.1.45 などの文字列として、サイトの IP アドレスを文字列として含めることができます。 WinHttp は、最初に Punycodeに変換せずに国際ホスト名 受け入れないことを確認してください。 詳細については、「国際化ドメイン名 (IDN)の処理」を参照してください。

[in] nServerPort

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

価値 意味
INTERNET_DEFAULT_HTTP_PORT
HTTP サーバーの既定のポート (ポート 80) を使用します。
INTERNET_DEFAULT_HTTPS_PORT
HTTPS サーバーの既定のポート (ポート 443) を使用します。 このポートを選択しても、セキュリティで保護された接続は自動的に確立されません。 WinHttpOpenRequestで WINHTTP_FLAG_SECURE フラグを使用して、セキュリティで保護されたトランザクション セマンティクス 使用する必要があります。
INTERNET_DEFAULT_PORT
HTTP にはポート 80 を使用し、セキュリティで保護されたハイパーテキスト転送プロトコル (HTTPS) にはポート 443 を使用します。

[in] dwReserved

このパラメーターは予約済みであり、0 である必要があります。

戻り値

接続に成功した場合は 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 エラー コード)

備考

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

呼び出し元のアプリケーションが WinHttpConnectによって返される HINTERNET ハンドル の使用を終了した後、WinHttpCloseHandle 関数を使用して閉じる必要があります。

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

Windows XP および Windows 2000 の に関する注意: WinHttp のスタート ページの「Run-Time 要件」セクションを参照してください。
 

次の例は、セキュリティで保護されたトランザクション セマンティクスを使用して、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);

必要条件

要件 価値
サポートされる最小クライアント Windows XP、Windows 2000 Professional SP3 [デスクトップ アプリのみ]
サポートされる最小サーバー Windows Server 2003、Windows 2000 Server SP3 [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー winhttp.h
ライブラリ Winhttp.lib
DLL Winhttp.dll
再頒布可能パッケージの Windows XP および Windows 2000 の WinHTTP 5.0 および Internet Explorer 5.01 以降。

関連項目

Microsoft Windows HTTP Services (WinHTTP) について

WinHTTP バージョン

WinHttpCloseHandle

WinHttpOpen

WinHttpOpenRequest の