WebSocketBeginServerHandshake 函式 (websocket.h)

WebSocketBeginServerHandshake 函式會開始伺服器端交握。

語法

HRESULT WebSocketBeginServerHandshake(
  [in]           WEB_SOCKET_HANDLE             hWebSocket,
  [in, optional] PCSTR                         pszSubprotocolSelected,
  [in, optional] PCSTR                         *pszExtensionSelected,
  [in]           ULONG                         ulExtensionSelectedCount,
  [in]           const PWEB_SOCKET_HTTP_HEADER pRequestHeaders,
  [in]           ULONG                         ulRequestHeaderCount,
  [out]          PWEB_SOCKET_HTTP_HEADER       *pResponseHeaders,
  [out]          ULONG                         *pulResponseHeaderCount
);

參數

[in] hWebSocket

類型： WEB_SOCKET_HANDLE

先前呼叫 WebSocketCreateServerHandle 所傳回的 WebSocket 會話句柄。

[in, optional] pszSubprotocolSelected

類型： PCSTR

應用程式所選擇子通訊協定值的指標。 必須包含一個子程式。

[in, optional] pszExtensionSelected

類型： PCSTR*

應用程式所選擇之延伸模組清單的指標。 每個項目必須包含一個延伸模組。

[in] ulExtensionSelectedCount

類型： ULONG

pszExtensionSelected 中的擴充功能數目。

[in] pRequestHeaders

類型： const PWEB_SOCKET_HTTP_HEADER

包含應用程式所接收要求標頭之 WEB_SOCKET_HTTP_HEADER 結構的陣列指標。

[in] ulRequestHeaderCount

類型： ULONG

pRequestHeaders 中的要求標頭數目。

[out] pResponseHeaders

類型： PWEB_SOCKET_HTTP_HEADER*

成功輸出時，陣列或 WEB_SOCKET_HTTP_HEADER 結構的指標，其中包含應用程式要傳送的響應標頭。

[out] pulResponseHeaderCount

類型： ULONG*

成功輸出時， pResponseHeaders 中的響應標頭數目。

傳回值

類型： HRESULT

如果函式成功，它會傳回 S_OK。

如果函式失敗，它會傳回下列其中一個或 WinError.h 中定義的 系統錯誤碼 。

傳回碼	Description
E_INVALID_PROTOCOL_FORMAT	通訊協議數據的格式無效。

備註

若要完成伺服器端交握，應用程式必須呼叫 WebSocketEndServerHandshake 或任何會話函式。 用戶端-伺服器交握完成後，應用程式可以使用會話函式。

規格需求

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

另請參閱

WEB_SOCKET_HTTP_HEADER

WebSocketBeginClientHandshake

WebSocketEndClientHandshake

WebSocketEndServerHandshake