WebSocketSend-Funktion (websocket.h)

Die WebSocketSend-Funktion fügt der Vorgangswarteschlange der Protokollkomponente einen Sendevorgang hinzu.

Syntax

HRESULT WebSocketSend(
  [in]           WEB_SOCKET_HANDLE      hWebSocket,
  [in]           WEB_SOCKET_BUFFER_TYPE BufferType,
  [in, optional] WEB_SOCKET_BUFFER      *pBuffer,
  [in, optional] PVOID                  Context
);

Parameter

[in] hWebSocket

Typ: WEB_SOCKET_HANDLE

WebSocket-Sitzungshandle, das von einem vorherigen Aufruf von WebSocketCreateClientHandle oder WebSocketCreateServerHandle zurückgegeben wurde.

[in] BufferType

Typ: WEB_SOCKET_BUFFER_TYPE

Der Typ der WebSocket-Pufferdaten, die in pBuffer gesendet werden sollen.

[in, optional] pBuffer

Typ: WEB_SOCKET_BUFFER*

Ein Zeiger auf ein Array von WEB_SOCKET_BUFFER Strukturen, das zu sendende WebSocket-Pufferdaten enthält. Wenn BufferTypeWEB_SOCKET_PING_PONG_BUFFER_TYPE oder WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE ist, muss pBufferNULL sein.

[in, optional] Context

Typ: PVOID

Ein Zeiger auf ein Anwendungskontexthandle, das von einem nachfolgenden Aufruf von WebSocketGetAction zurückgegeben wird.

Rückgabewert

Typ: HRESULT

Wenn die Funktion erfolgreich ist, gibt sie S_OK zurück.

Wenn die Funktion fehlschlägt, gibt sie einen der folgenden oder einen in WinError.h definierten Systemfehlercode zurück.

Hinweise

Nachdem eine Anwendung einen WEB_SOCKET_CLOSE_BUFFER_TYPE WebSocket-Puffer erfolgreich gesendet hat, kann sie nur Steuerungsrahmen senden.

Anforderungen

Weitere Informationen

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketReceive