WebSocketSend 関数 (websocket.h)

[アーティクル]
03/03/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 で定義されている次のいずれかのシステムエラーコードが返されます。

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

注釈

アプリケーションは、WEB_SOCKET_CLOSE_BUFFER_TYPE WebSocket バッファーを正常に送信すると、制御フレームのみを送信できます。

要件

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