HttpWaitForDisconnect 関数 (http.h)

  • [アーティクル]

HttpWaitForDisconnect 関数は、何らかの理由で HTTP クライアントへの接続が切断されたときにアプリケーションに通知します。

構文

HTTPAPI_LINKAGE ULONG HttpWaitForDisconnect(
  [in] HANDLE             RequestQueueHandle,
  [in] HTTP_CONNECTION_ID ConnectionId,
  [in] LPOVERLAPPED       Overlapped
);

パラメーター

[in] RequestQueueHandle

指定した接続からの要求を処理する要求キューへのハンドル。 要求キューが作成され、そのハンドルが HttpCreateRequestQueue 関数の呼び出しによって返されます。

Windows Server 2003 SP1 と Windows XP SP2: 要求キューへのハンドルは、 HttpCreateHttpHandle 関数によって作成されます。

[in] ConnectionId

クライアント コンピューターへの接続の識別子。 この値は、HttpReceiveHttpRequest 関数の呼び出しによって、HTTP_REQUEST構造体の ConnectionID メンバーで返されます。

[in] Overlapped

非同期呼び出しの場合は、 pOverlapped を OVERLAPPED 構造体をポイントするように設定します。同期呼び出しの場合は、NULL に設定 します。

同期呼び出しは接続が切断されるまでブロックしますが、非同期呼び出しはERROR_IO_PENDINGを直ちに返し、呼び出し元のアプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作がいつ完了するかを判断します。 同期 に OVERLAPPED 構造体を使用する方法については、「 同期」および「重複した入力と出力」を参照してください。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が非同期的に使用される場合、戻り値ERROR_IO_PENDINGは、次の要求がまだ準備ができておらず、通常の重複した I/O 完了メカニズムを使用して後で取得されることを示します。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

値 説明
ERROR_INVALID_PARAMETER
 指定されたパラメーターの 1 つ以上が使用できない形式です。
その他
 WinError.h で定義されている システム エラー コード 。

要件

   
サポートされている最小のクライアント Windows Vista、SP2 を使用した Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー http.h
Library Httpapi.lib
[DLL] Httpapi.dll

関連項目

HTTP Server API バージョン 1.0 関数

HTTP_REQUEST