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 から返されたすべてのバッファー長の合計と異なる場合、現在の送信アクションは取り消され、WebSocketSend に渡されたすべてのバッファーが処理されなかった場合でも、次の WebSocketGetAction の呼び出しはWEB_SOCKET_INDICATE_SEND_COMPLETE_ACTIONを返します。
• WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: ulBytesTransferred が 0 の場合、現在の受信アクションは取り消され、WebSocketReceive に渡されたすべてのバッファーが処理されなかった場合でも、WebSocketGetAction の次の呼び出しはWEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTIONを返します。

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	websocket.h
Library	Websocket.lib
[DLL]	Websocket.dll

こちらもご覧ください

WEB_SOCKET_ACTION

WebSocketGetAction