WebSocketCompleteAction 函式 (websocket.h)

WebSocketCompleteAction 函式會完成由WebSocketGetAction 啟動的動作。

語法

void WebSocketCompleteAction(
  [in] WEB_SOCKET_HANDLE hWebSocket,
  [in] PVOID             pvActionContext,
  [in] ULONG             ulBytesTransferred
);

參數

[in] hWebSocket

類型： WEB_SOCKET_HANDLE

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

[in] pvActionContext

類型： PVOID

先前呼叫 WebSocketGetAction 所傳回之動作內容句柄的指標。

[in] ulBytesTransferred

類型： ULONG

針對 WEB_SOCKET_SEND_TO_NETWORK_ACTION 或 WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION 動作傳輸的位元元組數。 所有其他動作的這個值都必須是 0。

傳回值

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

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

備註

每個 WebSocketGetAction 呼叫都必須與 WebSocketCompleteAction 的呼叫配對。 針對下列網路動作，可能會發生 I/O 錯誤：

• WEB_SOCKET_SEND_TO_NETWORK_ACTION：如果 ulBytesTransferred 與 從 WebSocketGetAction 傳回的所有緩衝區長度總和不同，則會取消目前傳送動作，且下一次呼叫 WebSocketGetAction 會傳回 WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION 即使未處理傳遞至 WebSocketSend 的所有緩衝區也一樣。
• WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION：如果 ulBytesTransferred 為0，則會取消目前的接收動作，且下一次呼叫 WebSocketGetAction 會 傳回WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION ，即使未處理傳遞至 WebSocketReceive 的所有緩衝區也一樣。

規格需求

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

另請參閱

WEB_SOCKET_ACTION

WebSocketGetAction