WinHttpWebSocketCompleteUpgrade 関数 (winhttp.h)

WinHttpWebSocketCompleteUpgrade 関数は、WinHttpSendRequest によって開始された WebSocket ハンドシェイクを完了します。

構文

WINHTTPAPI HINTERNET WinHttpWebSocketCompleteUpgrade(
  [in]           HINTERNET hRequest,
  [in, optional] DWORD_PTR pContext
);

[in] hRequest

型: HINTERNET

WebSocket ハンドシェイクの送信に使用される HTTP 要求ハンドル。

[in, optional] pContext

種類: DWORD_PTR

新しいハンドルに関連付けるコンテキスト。

型: HINTERNET

新しい WebSocket ハンドル。 NULL の場合は、 GetLastError を呼び出してエラーの原因を特定します。

開いている HTTP 要求で WinHttpWebSocketCompleteUpgrade を呼び出して、他の WebSocket 操作を実行するための WebSocket ハンドルを取得できます。

要求ハンドルは、要求を送信する前に、WINHTTP_OPTION_UPGRADE_TO_WEB_SOCKETで WinHttpSetOption を呼び出すことによって WebSocket アップグレードとしてマークする必要があります。

呼び出し元は、サーバーから返された HTTP 状態コードをチェックし、状態コードが 101 の場合にのみこの関数を呼び出す必要があります。他の状態コードで呼び出すと、エラーが発生します。