WebSocketSend 函式 (websocket.h)

發行項
03/13/2024

WebSocketSend 函式會將傳送作業新增至通訊協定元件作業佇列。

語法

HRESULT WebSocketSend(
  [in]           WEB_SOCKET_HANDLE      hWebSocket,
  [in]           WEB_SOCKET_BUFFER_TYPE BufferType,
  [in, optional] WEB_SOCKET_BUFFER      *pBuffer,
  [in, optional] PVOID                  Context
);

參數

[in] hWebSocket

類型： WEB_SOCKET_HANDLE

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

[in] BufferType

類型： WEB_SOCKET_BUFFER_TYPE

要在 pBuffer 中傳送的 WebSocket 緩衝區數據類型。

[in, optional] pBuffer

類型： WEB_SOCKET_BUFFER*

包含要傳送之 WebSocket 緩衝區數據的 WEB_SOCKET_BUFFER 結構陣列指標。如果 BufferType是WEB_SOCKET_PING_PONG_BUFFER_TYPE或WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE，pBuffer 必須是 NULL。

注意一旦 WebSocketGetAction 針對此動作傳回WEB_SOCKET_INDICATE_SEND_COMPLETE，即可回收 pBuffer 的記憶體指標。

[in, optional] Context

類型： PVOID

後續呼叫 WebSocketGetAction 所傳回之應用程式內容句柄的指標。

傳回值

類型： HRESULT

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

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

傳回碼	Description
E_INVALID_PROTOCOL_OPERATION	通訊協定執行了無效的作業。

備註

應用程式成功傳送 WEB_SOCKET_CLOSE_BUFFER_TYPE WebSocket 緩衝區之後，它只能傳送控制畫面。

規格需求

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