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*

WebSocket データが WebSocketGetAction によって返されるときに書き込まれるWEB_SOCKET_BUFFER構造体の配列へのポインター。 NULL の場合、WebSocketGetAction は、ゼロ コピーシナリオを可能にする内部バッファーを返します。

メモこのアクションに対して WebSocketGetAction によってWEB_SOCKET_INDICATE_RECEIVE_COMPLETEが返されると、pBuffer による へのメモリ ポインターを再利用できます。

 

[in, optional] pvContext

種類: PVOID

WebSocketGetAction の後続の呼び出しによって返されるアプリケーション コンテキスト ハンドルへのポインター。

戻り値

型: HRESULT

関数が成功した場合は、S_OK を返します。

関数が失敗した場合は、WinError.h で定義されている次のいずれかの システム エラー コード が返されます。

リターン コード	説明
E_INVALID_PROTOCOL_OPERATION	プロトコルで無効な操作が実行されました。

要件

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

こちらもご覧ください

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend