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 來判斷失敗的原因。

備註

WinHttpWebSocketCompleteUpgrade 可以在開啟的 HTTP 要求上呼叫,以取得用於執行其他 WebSocket 作業的 WebSocket 控制碼。

要求控制碼必須透過呼叫 WinHttpSetOptionWINHTTP_OPTION_UPGRADE_TO_WEB_SOCKET ,再傳送要求,將要求控制碼標示為 WebSocket 升級。

呼叫端應該檢查伺服器傳回的 HTTP 狀態碼,且只有在狀態碼為 101 時,才呼叫此函式。 使用任何其他狀態碼呼叫它將會導致失敗。

規格需求

   
最低支援的用戶端 Windows 8 [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2012 [僅限傳統型應用程式]
目標平台 Windows
標頭 winHTTP.h
程式庫 WinHTTP.lib
Dll Winhttp.dll