WebSocketReceive 函式 (websocket.h)

WebSocketReceive 函式會將接收作業新增至通訊協定元件作業佇列。

語法

HRESULT WebSocketReceive(
  [in]           WEB_SOCKET_HANDLE hWebSocket,
  [in, optional] WEB_SOCKET_BUFFER *pBuffer,
  [in, optional] PVOID             pvContext
);

參數

[in] hWebSocket

類型： WEB_SOCKET_HANDLE

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

[in, optional] pBuffer

類型： WEB_SOCKET_BUFFER*

WebSocketGetAction 傳回 WebSocket 數據時，會寫入WEB_SOCKET_BUFFER結構的陣列指標。 如果 為NULL，WebSocketGetAction 會傳回可啟用零複製案例的內部緩衝區。

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

 

[in, optional] pvContext

類型： PVOID

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

傳回值

類型： HRESULT

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

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

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

規格需求

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

另請參閱

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend